PreviewInspector
Nodepod API / src / PreviewInspector
Class: PreviewInspector
Section titled “Class: PreviewInspector”Defined in: src/sdk/preview-inspector.ts:57
Host side of the opt-in, iframe-scoped preview inspection bridge.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PreviewInspector(
proxy,instanceId,assertActive):PreviewInspector
Defined in: src/sdk/preview-inspector.ts:65
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
assertActive
Section titled “assertActive”() => void
Returns
Section titled “Returns”PreviewInspector
Methods
Section titled “Methods”a11y()
Section titled “a11y()”a11y(
target):Promise<InspectResult<InspectA11yNode|InspectA11yViolation[]>>
Defined in: src/sdk/preview-inspector.ts:121
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<InspectA11yNode | InspectA11yViolation[]>>
act(
target):Promise<InspectResult<InspectActionResult>>
Defined in: src/sdk/preview-inspector.ts:123
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & InspectAction
Returns
Section titled “Returns”Promise<InspectResult<InspectActionResult>>
attach()
Section titled “attach()”attach(
__namedParameters):void
Defined in: src/sdk/preview-inspector.ts:83
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”void
console()
Section titled “console()”console(
target):Promise<InspectResult<InspectConsoleEntry[]>>
Defined in: src/sdk/preview-inspector.ts:118
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<InspectConsoleEntry[]>>
detach()
Section titled “detach()”detach(
port):void
Defined in: src/sdk/preview-inspector.ts:89
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
disable()
Section titled “disable()”disable():
Promise<void>
Defined in: src/sdk/preview-inspector.ts:74
Returns
Section titled “Returns”Promise<void>
dispose()
Section titled “dispose()”dispose():
void
Defined in: src/sdk/preview-inspector.ts:128
Returns
Section titled “Returns”void
documentSize()
Section titled “documentSize()”documentSize(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:113
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Promise<InspectResult<unknown>>
dom(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:116
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<unknown>>
enable()
Section titled “enable()”enable():
Promise<void>
Defined in: src/sdk/preview-inspector.ts:67
Returns
Section titled “Returns”Promise<void>
errors()
Section titled “errors()”errors(
target):Promise<InspectResult<InspectErrorEntry[]>>
Defined in: src/sdk/preview-inspector.ts:119
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<InspectErrorEntry[]>>
interactives()
Section titled “interactives()”interactives(
target):Promise<InspectResult<InspectInteractiveNode[]>>
Defined in: src/sdk/preview-inspector.ts:122
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Promise<InspectResult<InspectInteractiveNode[]>>
navigation()
Section titled “navigation()”navigation(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:120
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Promise<InspectResult<unknown>>
networkFailures()
Section titled “networkFailures()”networkFailures(
target):Promise<InspectResult<InspectNetworkFailure[]>>
Defined in: src/sdk/preview-inspector.ts:124
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<InspectNetworkFailure[]>>
on(
event,options,maybeHandler?): () =>void
Defined in: src/sdk/preview-inspector.ts:102
Parameters
Section titled “Parameters”options
Section titled “options”{ port?: number; } | ((data) => void)
maybeHandler?
Section titled “maybeHandler?”(data) => void
Returns
Section titled “Returns”() => void
overflow()
Section titled “overflow()”overflow(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:114
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Promise<InspectResult<unknown>>
ports()
Section titled “ports()”ports():
object[]
Defined in: src/sdk/preview-inspector.ts:97
Returns
Section titled “Returns”object[]
query()
Section titled “query()”query(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:117
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<unknown>>
screenshot()
Section titled “screenshot()”screenshot(
target):Promise<InspectResult<InspectScreenshot>>
Defined in: src/sdk/preview-inspector.ts:125
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<InspectScreenshot>>
snapshot()
Section titled “snapshot()”snapshot(
target):Promise<InspectResult<InspectSnapshot>>
Defined in: src/sdk/preview-inspector.ts:126
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<InspectSnapshot>>
text()
Section titled “text()”text(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:115
Parameters
Section titled “Parameters”target
Section titled “target”InspectTarget & object
Returns
Section titled “Returns”Promise<InspectResult<unknown>>
viewport()
Section titled “viewport()”viewport(
target):Promise<InspectResult<unknown>>
Defined in: src/sdk/preview-inspector.ts:112
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Promise<InspectResult<unknown>>