Node

inspector

Session

class Session

extends EventEmitter

The inspector.Session is used for dispatching messages to the V8 inspector back-end and receiving message responses and notifications.

Constructors #

#Session()

new

Create a new instance of the inspector.Session class. The inspector session needs to be connected through session.connect() before the messages can be dispatched to the inspector backend.

Methods #

#addListener(event: string,
listener: (...args: any[]) => void,
): this

#addListener(event: "inspectorNotification",
listener: (message: InspectorNotification<object>) => void,
): this

Emitted when any notification from the V8 Inspector is received.

#addListener(event: "Runtime.executionContextCreated",
listener: (message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>) => void,
): this

Issued when new execution context is created.

#addListener(event: "Runtime.executionContextDestroyed",
listener: (message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>) => void,
): this

Issued when execution context is destroyed.

#addListener(event: "Runtime.executionContextsCleared",
listener: () => void,
): this

Issued when all executionContexts were cleared in browser

#addListener(event: "Runtime.exceptionThrown",
listener: (message: InspectorNotification<Runtime.ExceptionThrownEventDataType>) => void,
): this

Issued when exception was thrown and unhandled.

#addListener(event: "Runtime.exceptionRevoked",
listener: (message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>) => void,
): this

Issued when unhandled exception was revoked.

#addListener(event: "Runtime.consoleAPICalled",
listener: (message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>) => void,
): this

Issued when console API was called.

#addListener(event: "Runtime.inspectRequested",
listener: (message: InspectorNotification<Runtime.InspectRequestedEventDataType>) => void,
): this

Issued when object should be inspected (for example, as a result of inspect() command line API call).

#addListener(event: "Debugger.scriptParsed",
listener: (message: InspectorNotification<Debugger.ScriptParsedEventDataType>) => void,
): this

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

#addListener(event: "Debugger.scriptFailedToParse",
listener: (message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>) => void,
): this

Fired when virtual machine fails to parse the script.

#addListener(event: "Debugger.breakpointResolved",
listener: (message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>) => void,
): this

Fired when breakpoint is resolved to an actual script and location.

#addListener(event: "Debugger.paused",
listener: (message: InspectorNotification<Debugger.PausedEventDataType>) => void,
): this

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

#addListener(event: "Debugger.resumed",
listener: () => void,
): this

Fired when the virtual machine resumed execution.

#addListener(event: "Console.messageAdded",
listener: (message: InspectorNotification<Console.MessageAddedEventDataType>) => void,
): this

Issued when new console message is added.

#addListener(event: "Profiler.consoleProfileStarted",
listener: (message: InspectorNotification<Profiler.ConsoleProfileStartedEventDataType>) => void,
): this

Sent when new profile recording is started using console.profile() call.

#addListener(event: "Profiler.consoleProfileFinished",
listener: (message: InspectorNotification<Profiler.ConsoleProfileFinishedEventDataType>) => void,
): this

#addListener(event: "HeapProfiler.addHeapSnapshotChunk",
listener: (message: InspectorNotification<HeapProfiler.AddHeapSnapshotChunkEventDataType>) => void,
): this

#addListener(event: "HeapProfiler.resetProfiles",
listener: () => void,
): this

#addListener(event: "HeapProfiler.reportHeapSnapshotProgress",
listener: (message: InspectorNotification<HeapProfiler.ReportHeapSnapshotProgressEventDataType>) => void,
): this

#addListener(event: "HeapProfiler.lastSeenObjectId",
listener: (message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>) => void,
): this

If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.

#addListener(event: "HeapProfiler.heapStatsUpdate",
listener: (message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>) => void,
): this

If heap objects tracking has been started then backend may send update for one or more fragments

#addListener(event: "NodeTracing.dataCollected",
listener: (message: InspectorNotification<NodeTracing.DataCollectedEventDataType>) => void,
): this

Contains an bucket of collected trace events.

#addListener(event: "NodeTracing.tracingComplete",
listener: () => void,
): this

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

#addListener(event: "NodeWorker.attachedToWorker",
listener: (message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>) => void,
): this

Issued when attached to a worker.

#addListener(event: "NodeWorker.detachedFromWorker",
listener: (message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>) => void,
): this

Issued when detached from the worker.

#addListener(event: "NodeWorker.receivedMessageFromWorker",
listener: (message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>) => void,
): this

Notifies about a new protocol message received from the session (session ID is provided in attachedToWorker notification).

#addListener(event: "Network.requestWillBeSent",
listener: (message: InspectorNotification<Network.RequestWillBeSentEventDataType>) => void,
): this

Fired when page is about to send HTTP request.

#addListener(event: "Network.responseReceived",
listener: (message: InspectorNotification<Network.ResponseReceivedEventDataType>) => void,
): this

Fired when HTTP response is available.

#addListener(event: "Network.loadingFailed",
listener: (message: InspectorNotification<Network.LoadingFailedEventDataType>) => void,
): this

#addListener(event: "Network.loadingFinished",
listener: (message: InspectorNotification<Network.LoadingFinishedEventDataType>) => void,
): this

#addListener(event: "NodeRuntime.waitingForDisconnect",
listener: () => void,
): this

This event is fired instead of Runtime.executionContextDestroyed when enabled. It is fired when the Node process finished all code execution and is waiting for all frontends to disconnect.

#addListener(event: "NodeRuntime.waitingForDebugger",
listener: () => void,
): this

This event is fired when the runtime is waiting for the debugger. For example, when inspector.waitingForDebugger is called

#connect(): void

Connects a session to the inspector back-end.

#connectToMainThread(): void

Connects a session to the inspector back-end. An exception will be thrown if this API was not called on a Worker thread.

#disconnect(): void

Immediately close the session. All pending message callbacks will be called with an error. session.connect() will need to be called to be able to send messages again. Reconnected session will lose all inspector state, such as enabled agents or configured breakpoints.

#emit(event: string | symbol,
...args: any[],
): boolean

#emit(event: "inspectorNotification",
message: InspectorNotification<object>,
): boolean

#emit(event: "Runtime.executionContextCreated",
message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>,
): boolean

#emit(event: "Runtime.executionContextDestroyed",
message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>,
): boolean

#emit(event: "Runtime.executionContextsCleared"): boolean

#emit(event: "Runtime.exceptionThrown",
message: InspectorNotification<Runtime.ExceptionThrownEventDataType>,
): boolean

#emit(event: "Runtime.exceptionRevoked",
message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>,
): boolean

#emit(event: "Runtime.consoleAPICalled",
message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>,
): boolean

#emit(event: "Runtime.inspectRequested",
message: InspectorNotification<Runtime.InspectRequestedEventDataType>,
): boolean

#emit(event: "Debugger.scriptParsed",
message: InspectorNotification<Debugger.ScriptParsedEventDataType>,
): boolean

#emit(event: "Debugger.scriptFailedToParse",
message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>,
): boolean

#emit(event: "Debugger.breakpointResolved",
message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>,
): boolean

#emit(event: "Debugger.paused",
message: InspectorNotification<Debugger.PausedEventDataType>,
): boolean

#emit(event: "Debugger.resumed"): boolean

#emit(event: "Console.messageAdded",
message: InspectorNotification<Console.MessageAddedEventDataType>,
): boolean

#emit(event: "Profiler.consoleProfileStarted",
message: InspectorNotification<Profiler.ConsoleProfileStartedEventDataType>,
): boolean

#emit(event: "Profiler.consoleProfileFinished",
message: InspectorNotification<Profiler.ConsoleProfileFinishedEventDataType>,
): boolean

#emit(event: "HeapProfiler.addHeapSnapshotChunk",
message: InspectorNotification<HeapProfiler.AddHeapSnapshotChunkEventDataType>,
): boolean

#emit(event: "HeapProfiler.resetProfiles"): boolean

#emit(event: "HeapProfiler.reportHeapSnapshotProgress",
message: InspectorNotification<HeapProfiler.ReportHeapSnapshotProgressEventDataType>,
): boolean

#emit(event: "HeapProfiler.lastSeenObjectId",
message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>,
): boolean

#emit(event: "HeapProfiler.heapStatsUpdate",
message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>,
): boolean

#emit(event: "NodeTracing.dataCollected",
message: InspectorNotification<NodeTracing.DataCollectedEventDataType>,
): boolean

#emit(event: "NodeTracing.tracingComplete"): boolean

#emit(event: "NodeWorker.attachedToWorker",
message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>,
): boolean

#emit(event: "NodeWorker.detachedFromWorker",
message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>,
): boolean

#emit(event: "NodeWorker.receivedMessageFromWorker",
message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>,
): boolean

#emit(event: "Network.requestWillBeSent",
message: InspectorNotification<Network.RequestWillBeSentEventDataType>,
): boolean

#emit(event: "Network.responseReceived",
message: InspectorNotification<Network.ResponseReceivedEventDataType>,
): boolean

#emit(event: "Network.loadingFailed",
message: InspectorNotification<Network.LoadingFailedEventDataType>,
): boolean

#emit(event: "Network.loadingFinished",
message: InspectorNotification<Network.LoadingFinishedEventDataType>,
): boolean

#emit(event: "NodeRuntime.waitingForDisconnect"): boolean

#emit(event: "NodeRuntime.waitingForDebugger"): boolean

#on(event: string,
listener: (...args: any[]) => void,
): this

#on(event: "inspectorNotification",
listener: (message: InspectorNotification<object>) => void,
): this

Emitted when any notification from the V8 Inspector is received.

#on(event: "Runtime.executionContextCreated",
listener: (message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>) => void,
): this

Issued when new execution context is created.

#on(event: "Runtime.executionContextDestroyed",
listener: (message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>) => void,
): this

Issued when execution context is destroyed.

#on(event: "Runtime.executionContextsCleared",
listener: () => void,
): this

Issued when all executionContexts were cleared in browser

#on(event: "Runtime.exceptionThrown",
listener: (message: InspectorNotification<Runtime.ExceptionThrownEventDataType>) => void,
): this

Issued when exception was thrown and unhandled.

#on(event: "Runtime.exceptionRevoked",
listener: (message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>) => void,
): this

Issued when unhandled exception was revoked.

#on(event: "Runtime.consoleAPICalled",
listener: (message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>) => void,
): this

Issued when console API was called.

#on(event: "Runtime.inspectRequested",
listener: (message: InspectorNotification<Runtime.InspectRequestedEventDataType>) => void,
): this

Issued when object should be inspected (for example, as a result of inspect() command line API call).

#on(event: "Debugger.scriptParsed",
listener: (message: InspectorNotification<Debugger.ScriptParsedEventDataType>) => void,
): this

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

#on(event: "Debugger.scriptFailedToParse",
listener: (message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>) => void,
): this

Fired when virtual machine fails to parse the script.

#on(event: "Debugger.breakpointResolved",
listener: (message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>) => void,
): this

Fired when breakpoint is resolved to an actual script and location.

#on(event: "Debugger.paused",
listener: (message: InspectorNotification<Debugger.PausedEventDataType>) => void,
): this

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

#on(event: "Debugger.resumed",
listener: () => void,
): this

Fired when the virtual machine resumed execution.

#on(event: "Console.messageAdded",
listener: (message: InspectorNotification<Console.MessageAddedEventDataType>) => void,
): this

Issued when new console message is added.

#on(event: "Profiler.consoleProfileStarted",
listener: (message: InspectorNotification<Profiler.ConsoleProfileStartedEventDataType>) => void,
): this

Sent when new profile recording is started using console.profile() call.

#on(event: "Profiler.consoleProfileFinished",
listener: (message: InspectorNotification<Profiler.ConsoleProfileFinishedEventDataType>) => void,
): this

#on(event: "HeapProfiler.addHeapSnapshotChunk",
listener: (message: InspectorNotification<HeapProfiler.AddHeapSnapshotChunkEventDataType>) => void,
): this

#on(event: "HeapProfiler.resetProfiles",
listener: () => void,
): this

#on(event: "HeapProfiler.reportHeapSnapshotProgress",
listener: (message: InspectorNotification<HeapProfiler.ReportHeapSnapshotProgressEventDataType>) => void,
): this

#on(event: "HeapProfiler.lastSeenObjectId",
listener: (message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>) => void,
): this

#on(event: "HeapProfiler.heapStatsUpdate",
listener: (message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>) => void,
): this

If heap objects tracking has been started then backend may send update for one or more fragments

#on(event: "NodeTracing.dataCollected",
listener: (message: InspectorNotification<NodeTracing.DataCollectedEventDataType>) => void,
): this

Contains an bucket of collected trace events.

#on(event: "NodeTracing.tracingComplete",
listener: () => void,
): this

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

#on(event: "NodeWorker.attachedToWorker",
listener: (message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>) => void,
): this

Issued when attached to a worker.

#on(event: "NodeWorker.detachedFromWorker",
listener: (message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>) => void,
): this

Issued when detached from the worker.

#on(event: "NodeWorker.receivedMessageFromWorker",
listener: (message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>) => void,
): this

Notifies about a new protocol message received from the session (session ID is provided in attachedToWorker notification).

#on(event: "Network.requestWillBeSent",
listener: (message: InspectorNotification<Network.RequestWillBeSentEventDataType>) => void,
): this

Fired when page is about to send HTTP request.

#on(event: "Network.responseReceived",
listener: (message: InspectorNotification<Network.ResponseReceivedEventDataType>) => void,
): this

Fired when HTTP response is available.

#on(event: "Network.loadingFailed",
listener: (message: InspectorNotification<Network.LoadingFailedEventDataType>) => void,
): this

#on(event: "Network.loadingFinished",
listener: (message: InspectorNotification<Network.LoadingFinishedEventDataType>) => void,
): this

#on(event: "NodeRuntime.waitingForDisconnect",
listener: () => void,
): this

This event is fired instead of Runtime.executionContextDestroyed when enabled. It is fired when the Node process finished all code execution and is waiting for all frontends to disconnect.

#on(event: "NodeRuntime.waitingForDebugger",
listener: () => void,
): this

This event is fired when the runtime is waiting for the debugger. For example, when inspector.waitingForDebugger is called

#once(event: string,
listener: (...args: any[]) => void,
): this

#once(event: "inspectorNotification",
listener: (message: InspectorNotification<object>) => void,
): this

Emitted when any notification from the V8 Inspector is received.

#once(event: "Runtime.executionContextCreated",
listener: (message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>) => void,
): this

Issued when new execution context is created.

#once(event: "Runtime.executionContextDestroyed",
listener: (message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>) => void,
): this

Issued when execution context is destroyed.

#once(event: "Runtime.executionContextsCleared",
listener: () => void,
): this

Issued when all executionContexts were cleared in browser

#once(event: "Runtime.exceptionThrown",
listener: (message: InspectorNotification<Runtime.ExceptionThrownEventDataType>) => void,
): this

Issued when exception was thrown and unhandled.

#once(event: "Runtime.exceptionRevoked",
listener: (message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>) => void,
): this

Issued when unhandled exception was revoked.

#once(event: "Runtime.consoleAPICalled",
listener: (message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>) => void,
): this

Issued when console API was called.

#once(event: "Runtime.inspectRequested",
listener: (message: InspectorNotification<Runtime.InspectRequestedEventDataType>) => void,
): this

Issued when object should be inspected (for example, as a result of inspect() command line API call).

#once(event: "Debugger.scriptParsed",
listener: (message: InspectorNotification<Debugger.ScriptParsedEventDataType>) => void,
): this

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

#once(event: "Debugger.scriptFailedToParse",
listener: (message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>) => void,
): this

Fired when virtual machine fails to parse the script.

#once(event: "Debugger.breakpointResolved",
listener: (message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>) => void,
): this

Fired when breakpoint is resolved to an actual script and location.

#once(event: "Debugger.paused",
listener: (message: InspectorNotification<Debugger.PausedEventDataType>) => void,
): this

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

#once(event: "Debugger.resumed",
listener: () => void,
): this

Fired when the virtual machine resumed execution.

#once(event: "Console.messageAdded",
listener: (message: InspectorNotification<Console.MessageAddedEventDataType>) => void,
): this

Issued when new console message is added.

#once(event: "Profiler.consoleProfileStarted",
listener: (message: InspectorNotification<Profiler.ConsoleProfileStartedEventDataType>) => void,
): this

Sent when new profile recording is started using console.profile() call.

#once(event: "Profiler.consoleProfileFinished",
listener: (message: InspectorNotification<Profiler.ConsoleProfileFinishedEventDataType>) => void,
): this

#once(event: "HeapProfiler.addHeapSnapshotChunk",
listener: (message: InspectorNotification<HeapProfiler.AddHeapSnapshotChunkEventDataType>) => void,
): this

#once(event: "HeapProfiler.resetProfiles",
listener: () => void,
): this

#once(event: "HeapProfiler.reportHeapSnapshotProgress",
listener: (message: InspectorNotification<HeapProfiler.ReportHeapSnapshotProgressEventDataType>) => void,
): this

#once(event: "HeapProfiler.lastSeenObjectId",
listener: (message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>) => void,
): this

#once(event: "HeapProfiler.heapStatsUpdate",
listener: (message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>) => void,
): this

If heap objects tracking has been started then backend may send update for one or more fragments

#once(event: "NodeTracing.dataCollected",
listener: (message: InspectorNotification<NodeTracing.DataCollectedEventDataType>) => void,
): this

Contains an bucket of collected trace events.

#once(event: "NodeTracing.tracingComplete",
listener: () => void,
): this

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

#once(event: "NodeWorker.attachedToWorker",
listener: (message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>) => void,
): this

Issued when attached to a worker.

#once(event: "NodeWorker.detachedFromWorker",
listener: (message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>) => void,
): this

Issued when detached from the worker.

#once(event: "NodeWorker.receivedMessageFromWorker",
listener: (message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>) => void,
): this

Notifies about a new protocol message received from the session (session ID is provided in attachedToWorker notification).

#once(event: "Network.requestWillBeSent",
listener: (message: InspectorNotification<Network.RequestWillBeSentEventDataType>) => void,
): this

Fired when page is about to send HTTP request.

#once(event: "Network.responseReceived",
listener: (message: InspectorNotification<Network.ResponseReceivedEventDataType>) => void,
): this

Fired when HTTP response is available.

#once(event: "Network.loadingFailed",
listener: (message: InspectorNotification<Network.LoadingFailedEventDataType>) => void,
): this

#once(event: "Network.loadingFinished",
listener: (message: InspectorNotification<Network.LoadingFinishedEventDataType>) => void,
): this

#once(event: "NodeRuntime.waitingForDisconnect",
listener: () => void,
): this

This event is fired instead of Runtime.executionContextDestroyed when enabled. It is fired when the Node process finished all code execution and is waiting for all frontends to disconnect.

#once(event: "NodeRuntime.waitingForDebugger",
listener: () => void,
): this

This event is fired when the runtime is waiting for the debugger. For example, when inspector.waitingForDebugger is called

#post(method: string,
callback?: (err: Error | null,
params?: object,
) => void,
): void

Posts a message to the inspector back-end. callback will be notified when a response is received. callback is a function that accepts two optional arguments: error and message-specific result.

session.post('Runtime.evaluate', { expression: '2 + 2' },
             (error, { result }) => console.log(result));
// Output: { type: 'number', value: 4, description: '4' }

The latest version of the V8 inspector protocol is published on the Chrome DevTools Protocol Viewer.

Node.js inspector supports all the Chrome DevTools Protocol domains declared by V8. Chrome DevTools Protocol domain provides an interface for interacting with one of the runtime agents used to inspect the application state and listen to the run-time events.

#post(method: string,
params?: object,
callback?: (err: Error | null,
params?: object,
) => void,
): void

#post(method: "Schema.getDomains",
callback?: (err: Error | null,
params: Schema.GetDomainsReturnType,
) => void,
): void

Returns supported domains.

#post(method: "Runtime.evaluate",
params?: Runtime.EvaluateParameterType,
callback?: (err: Error | null,
params: Runtime.EvaluateReturnType,
) => void,
): void

Evaluates expression on global object.

#post(method: "Runtime.evaluate",
callback?: (err: Error | null,
params: Runtime.EvaluateReturnType,
) => void,
): void

#post(method: "Runtime.awaitPromise",
params?: Runtime.AwaitPromiseParameterType,
callback?: (err: Error | null,
params: Runtime.AwaitPromiseReturnType,
) => void,
): void

Add handler to promise with given promise object id.

#post(method: "Runtime.awaitPromise",
callback?: (err: Error | null,
params: Runtime.AwaitPromiseReturnType,
) => void,
): void

#post(method: "Runtime.callFunctionOn",
params?: Runtime.CallFunctionOnParameterType,
callback?: (err: Error | null,
params: Runtime.CallFunctionOnReturnType,
) => void,
): void

Calls function with given declaration on the given object. Object group of the result is inherited from the target object.

#post(method: "Runtime.callFunctionOn",
callback?: (err: Error | null,
params: Runtime.CallFunctionOnReturnType,
) => void,
): void

#post(method: "Runtime.getProperties",
params?: Runtime.GetPropertiesParameterType,
callback?: (err: Error | null,
params: Runtime.GetPropertiesReturnType,
) => void,
): void

Returns properties of a given object. Object group of the result is inherited from the target object.

#post(method: "Runtime.getProperties",
callback?: (err: Error | null,
params: Runtime.GetPropertiesReturnType,
) => void,
): void

#post(method: "Runtime.releaseObject",
params?: Runtime.ReleaseObjectParameterType,
callback?: (err: Error | null) => void,
): void

Releases remote object with given id.

#post(method: "Runtime.releaseObject",
callback?: (err: Error | null) => void,
): void

#post(method: "Runtime.releaseObjectGroup",
params?: Runtime.ReleaseObjectGroupParameterType,
callback?: (err: Error | null) => void,
): void

Releases all remote objects that belong to a given group.

#post(method: "Runtime.releaseObjectGroup",
callback?: (err: Error | null) => void,
): void

#post(method: "Runtime.runIfWaitingForDebugger",
callback?: (err: Error | null) => void,
): void

Tells inspected instance to run if it was waiting for debugger to attach.

#post(method: "Runtime.enable",
callback?: (err: Error | null) => void,
): void

Enables reporting of execution contexts creation by means of executionContextCreated event. When the reporting gets enabled the event will be sent immediately for each existing execution context.

#post(method: "Runtime.disable",
callback?: (err: Error | null) => void,
): void

Disables reporting of execution contexts creation.

#post(method: "Runtime.discardConsoleEntries",
callback?: (err: Error | null) => void,
): void

Discards collected exceptions and console API calls.

#post(method: "Runtime.setCustomObjectFormatterEnabled",
params?: Runtime.SetCustomObjectFormatterEnabledParameterType,
callback?: (err: Error | null) => void,
): void

#post(method: "Runtime.setCustomObjectFormatterEnabled",
callback?: (err: Error | null) => void,
): void

#post(method: "Runtime.compileScript",
params?: Runtime.CompileScriptParameterType,
callback?: (err: Error | null,
params: Runtime.CompileScriptReturnType,
) => void,
): void

Compiles expression.

#post(method: "Runtime.compileScript",
callback?: (err: Error | null,
params: Runtime.CompileScriptReturnType,
) => void,
): void

#post(method: "Runtime.runScript",
params?: Runtime.RunScriptParameterType,
callback?: (err: Error | null,
params: Runtime.RunScriptReturnType,
) => void,
): void

Runs script with given id in a given context.

#post(method: "Runtime.runScript",
callback?: (err: Error | null,
params: Runtime.RunScriptReturnType,
) => void,
): void

#post(method: "Runtime.queryObjects",
params?: Runtime.QueryObjectsParameterType,
callback?: (err: Error | null,
params: Runtime.QueryObjectsReturnType,
) => void,
): void

#post(method: "Runtime.queryObjects",
callback?: (err: Error | null,
params: Runtime.QueryObjectsReturnType,
) => void,
): void

#post(method: "Runtime.globalLexicalScopeNames",
params?: Runtime.GlobalLexicalScopeNamesParameterType,
callback?: (err: Error | null,
params: Runtime.GlobalLexicalScopeNamesReturnType,
) => void,
): void

Returns all let, const and class variables from global scope.

#post(method: "Runtime.globalLexicalScopeNames",
callback?: (err: Error | null,
params: Runtime.GlobalLexicalScopeNamesReturnType,
) => void,
): void

#post(method: "Debugger.enable",
callback?: (err: Error | null,
params: Debugger.EnableReturnType,
) => void,
): void

Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received.

#post(method: "Debugger.disable",
callback?: (err: Error | null) => void,
): void

Disables debugger for given page.

#post(method: "Debugger.setBreakpointsActive",
params?: Debugger.SetBreakpointsActiveParameterType,
callback?: (err: Error | null) => void,
): void

Activates / deactivates all breakpoints on the page.

#post(method: "Debugger.setBreakpointsActive",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.setSkipAllPauses",
params?: Debugger.SetSkipAllPausesParameterType,
callback?: (err: Error | null) => void,
): void

Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).

#post(method: "Debugger.setSkipAllPauses",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.setBreakpointByUrl",
params?: Debugger.SetBreakpointByUrlParameterType,
callback?: (err: Error | null,
params: Debugger.SetBreakpointByUrlReturnType,
) => void,
): void

Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads.

#post(method: "Debugger.setBreakpointByUrl",
callback?: (err: Error | null,
params: Debugger.SetBreakpointByUrlReturnType,
) => void,
): void

#post(method: "Debugger.setBreakpoint",
params?: Debugger.SetBreakpointParameterType,
callback?: (err: Error | null,
params: Debugger.SetBreakpointReturnType,
) => void,
): void

Sets JavaScript breakpoint at a given location.

#post(method: "Debugger.setBreakpoint",
callback?: (err: Error | null,
params: Debugger.SetBreakpointReturnType,
) => void,
): void

#post(method: "Debugger.removeBreakpoint",
params?: Debugger.RemoveBreakpointParameterType,
callback?: (err: Error | null) => void,
): void

Removes JavaScript breakpoint.

#post(method: "Debugger.removeBreakpoint",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.getPossibleBreakpoints",
params?: Debugger.GetPossibleBreakpointsParameterType,
callback?: (err: Error | null,
params: Debugger.GetPossibleBreakpointsReturnType,
) => void,
): void

Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.

#post(method: "Debugger.getPossibleBreakpoints",
callback?: (err: Error | null,
params: Debugger.GetPossibleBreakpointsReturnType,
) => void,
): void

#post(method: "Debugger.continueToLocation",
params?: Debugger.ContinueToLocationParameterType,
callback?: (err: Error | null) => void,
): void

Continues execution until specific location is reached.

#post(method: "Debugger.continueToLocation",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.pauseOnAsyncCall",
params?: Debugger.PauseOnAsyncCallParameterType,
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.pauseOnAsyncCall",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.stepOver",
callback?: (err: Error | null) => void,
): void

Steps over the statement.

#post(method: "Debugger.stepInto",
params?: Debugger.StepIntoParameterType,
callback?: (err: Error | null) => void,
): void

Steps into the function call.

#post(method: "Debugger.stepInto",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.stepOut",
callback?: (err: Error | null) => void,
): void

Steps out of the function call.

#post(method: "Debugger.pause",
callback?: (err: Error | null) => void,
): void

Stops on the next JavaScript statement.

#post(method: "Debugger.scheduleStepIntoAsync",
callback?: (err: Error | null) => void,
): void

This method is deprecated - use Debugger.stepInto with breakOnAsyncCall and Debugger.pauseOnAsyncTask instead. Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called.

#post(method: "Debugger.resume",
callback?: (err: Error | null) => void,
): void

Resumes JavaScript execution.

#post(method: "Debugger.getStackTrace",
params?: Debugger.GetStackTraceParameterType,
callback?: (err: Error | null,
params: Debugger.GetStackTraceReturnType,
) => void,
): void

Returns stack trace with given stackTraceId.

#post(method: "Debugger.getStackTrace",
callback?: (err: Error | null,
params: Debugger.GetStackTraceReturnType,
) => void,
): void

#post(method: "Debugger.searchInContent",
params?: Debugger.SearchInContentParameterType,
callback?: (err: Error | null,
params: Debugger.SearchInContentReturnType,
) => void,
): void

Searches for given string in script content.

#post(method: "Debugger.searchInContent",
callback?: (err: Error | null,
params: Debugger.SearchInContentReturnType,
) => void,
): void

#post(method: "Debugger.setScriptSource",
params?: Debugger.SetScriptSourceParameterType,
callback?: (err: Error | null,
params: Debugger.SetScriptSourceReturnType,
) => void,
): void

Edits JavaScript source live.

#post(method: "Debugger.setScriptSource",
callback?: (err: Error | null,
params: Debugger.SetScriptSourceReturnType,
) => void,
): void

#post(method: "Debugger.restartFrame",
params?: Debugger.RestartFrameParameterType,
callback?: (err: Error | null,
params: Debugger.RestartFrameReturnType,
) => void,
): void

Restarts particular call frame from the beginning.

#post(method: "Debugger.restartFrame",
callback?: (err: Error | null,
params: Debugger.RestartFrameReturnType,
) => void,
): void

#post(method: "Debugger.getScriptSource",
params?: Debugger.GetScriptSourceParameterType,
callback?: (err: Error | null,
params: Debugger.GetScriptSourceReturnType,
) => void,
): void

Returns source for the script with given id.

#post(method: "Debugger.getScriptSource",
callback?: (err: Error | null,
params: Debugger.GetScriptSourceReturnType,
) => void,
): void

#post(method: "Debugger.setPauseOnExceptions",
params?: Debugger.SetPauseOnExceptionsParameterType,
callback?: (err: Error | null) => void,
): void

Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is none.

#post(method: "Debugger.setPauseOnExceptions",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.evaluateOnCallFrame",
params?: Debugger.EvaluateOnCallFrameParameterType,
callback?: (err: Error | null,
params: Debugger.EvaluateOnCallFrameReturnType,
) => void,
): void

Evaluates expression on a given call frame.

#post(method: "Debugger.evaluateOnCallFrame",
callback?: (err: Error | null,
params: Debugger.EvaluateOnCallFrameReturnType,
) => void,
): void

#post(method: "Debugger.setVariableValue",
params?: Debugger.SetVariableValueParameterType,
callback?: (err: Error | null) => void,
): void

Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.

#post(method: "Debugger.setVariableValue",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.setReturnValue",
params?: Debugger.SetReturnValueParameterType,
callback?: (err: Error | null) => void,
): void

Changes return value in top frame. Available only at return break position.

#post(method: "Debugger.setReturnValue",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.setAsyncCallStackDepth",
params?: Debugger.SetAsyncCallStackDepthParameterType,
callback?: (err: Error | null) => void,
): void

Enables or disables async call stacks tracking.

#post(method: "Debugger.setAsyncCallStackDepth",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.setBlackboxPatterns",
params?: Debugger.SetBlackboxPatternsParameterType,
callback?: (err: Error | null) => void,
): void

Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful.

#post(method: "Debugger.setBlackboxPatterns",
callback?: (err: Error | null) => void,
): void

#post(method: "Debugger.setBlackboxedRanges",
params?: Debugger.SetBlackboxedRangesParameterType,
callback?: (err: Error | null) => void,
): void

Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted.

#post(method: "Debugger.setBlackboxedRanges",
callback?: (err: Error | null) => void,
): void

#post(method: "Console.enable",
callback?: (err: Error | null) => void,
): void

Enables console domain, sends the messages collected so far to the client by means of the messageAdded notification.

#post(method: "Console.disable",
callback?: (err: Error | null) => void,
): void

Disables console domain, prevents further console messages from being reported to the client.

#post(method: "Console.clearMessages",
callback?: (err: Error | null) => void,
): void

Does nothing.

#post(method: "Profiler.enable",
callback?: (err: Error | null) => void,
): void

#post(method: "Profiler.disable",
callback?: (err: Error | null) => void,
): void

#post(method: "Profiler.setSamplingInterval",
params?: Profiler.SetSamplingIntervalParameterType,
callback?: (err: Error | null) => void,
): void

Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.

#post(method: "Profiler.setSamplingInterval",
callback?: (err: Error | null) => void,
): void

#post(method: "Profiler.start",
callback?: (err: Error | null) => void,
): void

#post(method: "Profiler.stop",
callback?: (err: Error | null,
params: Profiler.StopReturnType,
) => void,
): void

#post(method: "Profiler.startPreciseCoverage",
params?: Profiler.StartPreciseCoverageParameterType,
callback?: (err: Error | null) => void,
): void

Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code coverage may be incomplete. Enabling prevents running optimized code and resets execution counters.

#post(method: "Profiler.startPreciseCoverage",
callback?: (err: Error | null) => void,
): void

#post(method: "Profiler.stopPreciseCoverage",
callback?: (err: Error | null) => void,
): void

Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code.

#post(method: "Profiler.takePreciseCoverage",
callback?: (err: Error | null,
params: Profiler.TakePreciseCoverageReturnType,
) => void,
): void

Collect coverage data for the current isolate, and resets execution counters. Precise code coverage needs to have started.

#post(method: "Profiler.getBestEffortCoverage",
callback?: (err: Error | null,
params: Profiler.GetBestEffortCoverageReturnType,
) => void,
): void

Collect coverage data for the current isolate. The coverage data may be incomplete due to garbage collection.

#post(method: "HeapProfiler.enable",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.disable",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.startTrackingHeapObjects",
params?: HeapProfiler.StartTrackingHeapObjectsParameterType,
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.startTrackingHeapObjects",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.stopTrackingHeapObjects",
params?: HeapProfiler.StopTrackingHeapObjectsParameterType,
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.stopTrackingHeapObjects",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.takeHeapSnapshot",
params?: HeapProfiler.TakeHeapSnapshotParameterType,
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.takeHeapSnapshot",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.collectGarbage",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.getObjectByHeapObjectId",
params?: HeapProfiler.GetObjectByHeapObjectIdParameterType,
callback?: (err: Error | null,
params: HeapProfiler.GetObjectByHeapObjectIdReturnType,
) => void,
): void

#post(method: "HeapProfiler.getObjectByHeapObjectId",
callback?: (err: Error | null,
params: HeapProfiler.GetObjectByHeapObjectIdReturnType,
) => void,
): void

#post(method: "HeapProfiler.addInspectedHeapObject",
params?: HeapProfiler.AddInspectedHeapObjectParameterType,
callback?: (err: Error | null) => void,
): void

Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions).

#post(method: "HeapProfiler.addInspectedHeapObject",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.getHeapObjectId",
params?: HeapProfiler.GetHeapObjectIdParameterType,
callback?: (err: Error | null,
params: HeapProfiler.GetHeapObjectIdReturnType,
) => void,
): void

#post(method: "HeapProfiler.getHeapObjectId",
callback?: (err: Error | null,
params: HeapProfiler.GetHeapObjectIdReturnType,
) => void,
): void

#post(method: "HeapProfiler.startSampling",
params?: HeapProfiler.StartSamplingParameterType,
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.startSampling",
callback?: (err: Error | null) => void,
): void

#post(method: "HeapProfiler.stopSampling",
callback?: (err: Error | null,
params: HeapProfiler.StopSamplingReturnType,
) => void,
): void

#post(method: "HeapProfiler.getSamplingProfile",
callback?: (err: Error | null,
params: HeapProfiler.GetSamplingProfileReturnType,
) => void,
): void

#post(method: "NodeTracing.getCategories",
callback?: (err: Error | null,
params: NodeTracing.GetCategoriesReturnType,
) => void,
): void

Gets supported tracing categories.

#post(method: "NodeTracing.start",
params?: NodeTracing.StartParameterType,
callback?: (err: Error | null) => void,
): void

Start trace events collection.

#post(method: "NodeTracing.start",
callback?: (err: Error | null) => void,
): void

#post(method: "NodeTracing.stop",
callback?: (err: Error | null) => void,
): void

Stop trace events collection. Remaining collected events will be sent as a sequence of dataCollected events followed by tracingComplete event.

#post(method: "NodeWorker.sendMessageToWorker",
params?: NodeWorker.SendMessageToWorkerParameterType,
callback?: (err: Error | null) => void,
): void

Sends protocol message over session with given id.

#post(method: "NodeWorker.sendMessageToWorker",
callback?: (err: Error | null) => void,
): void

#post(method: "NodeWorker.enable",
params?: NodeWorker.EnableParameterType,
callback?: (err: Error | null) => void,
): void

Instructs the inspector to attach to running workers. Will also attach to new workers as they start

#post(method: "NodeWorker.enable",
callback?: (err: Error | null) => void,
): void

#post(method: "NodeWorker.disable",
callback?: (err: Error | null) => void,
): void

Detaches from all running workers and disables attaching to new workers as they are started.

#post(method: "NodeWorker.detach",
params?: NodeWorker.DetachParameterType,
callback?: (err: Error | null) => void,
): void

Detached from the worker with given sessionId.

#post(method: "NodeWorker.detach",
callback?: (err: Error | null) => void,
): void

#post(method: "Network.disable",
callback?: (err: Error | null) => void,
): void

Disables network tracking, prevents network events from being sent to the client.

#post(method: "Network.enable",
callback?: (err: Error | null) => void,
): void

Enables network tracking, network events will now be delivered to the client.

#post(method: "NodeRuntime.enable",
callback?: (err: Error | null) => void,
): void

Enable the NodeRuntime events except by NodeRuntime.waitingForDisconnect.

#post(method: "NodeRuntime.disable",
callback?: (err: Error | null) => void,
): void

Disable NodeRuntime events

#post(method: "NodeRuntime.notifyWhenWaitingForDisconnect",
params?: NodeRuntime.NotifyWhenWaitingForDisconnectParameterType,
callback?: (err: Error | null) => void,
): void

Enable the NodeRuntime.waitingForDisconnect.

#post(method: "NodeRuntime.notifyWhenWaitingForDisconnect",
callback?: (err: Error | null) => void,
): void

#prependListener(event: string,
listener: (...args: any[]) => void,
): this

#prependListener(event: "inspectorNotification",
listener: (message: InspectorNotification<object>) => void,
): this

Emitted when any notification from the V8 Inspector is received.

#prependListener(event: "Runtime.executionContextCreated",
listener: (message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>) => void,
): this

Issued when new execution context is created.

#prependListener(event: "Runtime.executionContextDestroyed",
listener: (message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>) => void,
): this

Issued when execution context is destroyed.

#prependListener(event: "Runtime.executionContextsCleared",
listener: () => void,
): this

Issued when all executionContexts were cleared in browser

#prependListener(event: "Runtime.exceptionThrown",
listener: (message: InspectorNotification<Runtime.ExceptionThrownEventDataType>) => void,
): this

Issued when exception was thrown and unhandled.

#prependListener(event: "Runtime.exceptionRevoked",
listener: (message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>) => void,
): this

Issued when unhandled exception was revoked.

#prependListener(event: "Runtime.consoleAPICalled",
listener: (message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>) => void,
): this

Issued when console API was called.

#prependListener(event: "Runtime.inspectRequested",
listener: (message: InspectorNotification<Runtime.InspectRequestedEventDataType>) => void,
): this

Issued when object should be inspected (for example, as a result of inspect() command line API call).

#prependListener(event: "Debugger.scriptParsed",
listener: (message: InspectorNotification<Debugger.ScriptParsedEventDataType>) => void,
): this

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

#prependListener(event: "Debugger.scriptFailedToParse",
listener: (message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>) => void,
): this

Fired when virtual machine fails to parse the script.

#prependListener(event: "Debugger.breakpointResolved",
listener: (message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>) => void,
): this

Fired when breakpoint is resolved to an actual script and location.

#prependListener(event: "Debugger.paused",
listener: (message: InspectorNotification<Debugger.PausedEventDataType>) => void,
): this

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

#prependListener(event: "Debugger.resumed",
listener: () => void,
): this

Fired when the virtual machine resumed execution.

#prependListener(event: "Console.messageAdded",
listener: (message: InspectorNotification<Console.MessageAddedEventDataType>) => void,
): this

Issued when new console message is added.

#prependListener(event: "Profiler.consoleProfileStarted",
listener: (message: InspectorNotification<Profiler.ConsoleProfileStartedEventDataType>) => void,
): this

Sent when new profile recording is started using console.profile() call.

#prependListener(event: "Profiler.consoleProfileFinished",
listener: (message: InspectorNotification<Profiler.ConsoleProfileFinishedEventDataType>) => void,
): this

#prependListener(event: "HeapProfiler.addHeapSnapshotChunk",
listener: (message: InspectorNotification<HeapProfiler.AddHeapSnapshotChunkEventDataType>) => void,
): this

#prependListener(event: "HeapProfiler.resetProfiles",
listener: () => void,
): this

#prependListener(event: "HeapProfiler.reportHeapSnapshotProgress",
listener: (message: InspectorNotification<HeapProfiler.ReportHeapSnapshotProgressEventDataType>) => void,
): this

#prependListener(event: "HeapProfiler.lastSeenObjectId",
listener: (message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>) => void,
): this

#prependListener(event: "HeapProfiler.heapStatsUpdate",
listener: (message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>) => void,
): this

If heap objects tracking has been started then backend may send update for one or more fragments

#prependListener(event: "NodeTracing.dataCollected",
listener: (message: InspectorNotification<NodeTracing.DataCollectedEventDataType>) => void,
): this

Contains an bucket of collected trace events.

#prependListener(event: "NodeTracing.tracingComplete",
listener: () => void,
): this

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

#prependListener(event: "NodeWorker.attachedToWorker",
listener: (message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>) => void,
): this

Issued when attached to a worker.

#prependListener(event: "NodeWorker.detachedFromWorker",
listener: (message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>) => void,
): this

Issued when detached from the worker.

#prependListener(event: "NodeWorker.receivedMessageFromWorker",
listener: (message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>) => void,
): this

Notifies about a new protocol message received from the session (session ID is provided in attachedToWorker notification).

#prependListener(event: "Network.requestWillBeSent",
listener: (message: InspectorNotification<Network.RequestWillBeSentEventDataType>) => void,
): this

Fired when page is about to send HTTP request.

#prependListener(event: "Network.responseReceived",
listener: (message: InspectorNotification<Network.ResponseReceivedEventDataType>) => void,
): this

Fired when HTTP response is available.

#prependListener(event: "Network.loadingFailed",
listener: (message: InspectorNotification<Network.LoadingFailedEventDataType>) => void,
): this

#prependListener(event: "Network.loadingFinished",
listener: (message: InspectorNotification<Network.LoadingFinishedEventDataType>) => void,
): this

#prependListener(event: "NodeRuntime.waitingForDisconnect",
listener: () => void,
): this

This event is fired instead of Runtime.executionContextDestroyed when enabled. It is fired when the Node process finished all code execution and is waiting for all frontends to disconnect.

#prependListener(event: "NodeRuntime.waitingForDebugger",
listener: () => void,
): this

This event is fired when the runtime is waiting for the debugger. For example, when inspector.waitingForDebugger is called

#prependOnceListener(event: string,
listener: (...args: any[]) => void,
): this

#prependOnceListener(event: "inspectorNotification",
listener: (message: InspectorNotification<object>) => void,
): this

Emitted when any notification from the V8 Inspector is received.

#prependOnceListener(event: "Runtime.executionContextCreated",
listener: (message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>) => void,
): this

Issued when new execution context is created.

#prependOnceListener(event: "Runtime.executionContextDestroyed",
listener: (message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>) => void,
): this

Issued when execution context is destroyed.

#prependOnceListener(event: "Runtime.executionContextsCleared",
listener: () => void,
): this

Issued when all executionContexts were cleared in browser

#prependOnceListener(event: "Runtime.exceptionThrown",
listener: (message: InspectorNotification<Runtime.ExceptionThrownEventDataType>) => void,
): this

Issued when exception was thrown and unhandled.

#prependOnceListener(event: "Runtime.exceptionRevoked",
listener: (message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>) => void,
): this

Issued when unhandled exception was revoked.

#prependOnceListener(event: "Runtime.consoleAPICalled",
listener: (message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>) => void,
): this

Issued when console API was called.

#prependOnceListener(event: "Runtime.inspectRequested",
listener: (message: InspectorNotification<Runtime.InspectRequestedEventDataType>) => void,
): this

Issued when object should be inspected (for example, as a result of inspect() command line API call).

#prependOnceListener(event: "Debugger.scriptParsed",
listener: (message: InspectorNotification<Debugger.ScriptParsedEventDataType>) => void,
): this

Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.

#prependOnceListener(event: "Debugger.scriptFailedToParse",
listener: (message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>) => void,
): this

Fired when virtual machine fails to parse the script.

#prependOnceListener(event: "Debugger.breakpointResolved",
listener: (message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>) => void,
): this

Fired when breakpoint is resolved to an actual script and location.

#prependOnceListener(event: "Debugger.paused",
listener: (message: InspectorNotification<Debugger.PausedEventDataType>) => void,
): this

Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.

#prependOnceListener(event: "Debugger.resumed",
listener: () => void,
): this

Fired when the virtual machine resumed execution.

#prependOnceListener(event: "Console.messageAdded",
listener: (message: InspectorNotification<Console.MessageAddedEventDataType>) => void,
): this

Issued when new console message is added.

#prependOnceListener(event: "Profiler.consoleProfileStarted",
listener: (message: InspectorNotification<Profiler.ConsoleProfileStartedEventDataType>) => void,
): this

Sent when new profile recording is started using console.profile() call.

#prependOnceListener(event: "Profiler.consoleProfileFinished",
listener: (message: InspectorNotification<Profiler.ConsoleProfileFinishedEventDataType>) => void,
): this

#prependOnceListener(event: "HeapProfiler.addHeapSnapshotChunk",
listener: (message: InspectorNotification<HeapProfiler.AddHeapSnapshotChunkEventDataType>) => void,
): this

#prependOnceListener(event: "HeapProfiler.resetProfiles",
listener: () => void,
): this

#prependOnceListener(event: "HeapProfiler.reportHeapSnapshotProgress",
listener: (message: InspectorNotification<HeapProfiler.ReportHeapSnapshotProgressEventDataType>) => void,
): this

#prependOnceListener(event: "HeapProfiler.lastSeenObjectId",
listener: (message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>) => void,
): this

#prependOnceListener(event: "HeapProfiler.heapStatsUpdate",
listener: (message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>) => void,
): this

If heap objects tracking has been started then backend may send update for one or more fragments

#prependOnceListener(event: "NodeTracing.dataCollected",
listener: (message: InspectorNotification<NodeTracing.DataCollectedEventDataType>) => void,
): this

Contains an bucket of collected trace events.

#prependOnceListener(event: "NodeTracing.tracingComplete",
listener: () => void,
): this

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

#prependOnceListener(event: "NodeWorker.attachedToWorker",
listener: (message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>) => void,
): this

Issued when attached to a worker.

#prependOnceListener(event: "NodeWorker.detachedFromWorker",
listener: (message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>) => void,
): this

Issued when detached from the worker.

#prependOnceListener(event: "NodeWorker.receivedMessageFromWorker",
listener: (message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>) => void,
): this

Notifies about a new protocol message received from the session (session ID is provided in attachedToWorker notification).

#prependOnceListener(event: "Network.requestWillBeSent",
listener: (message: InspectorNotification<Network.RequestWillBeSentEventDataType>) => void,
): this

Fired when page is about to send HTTP request.

#prependOnceListener(event: "Network.responseReceived",
listener: (message: InspectorNotification<Network.ResponseReceivedEventDataType>) => void,
): this

Fired when HTTP response is available.

#prependOnceListener(event: "Network.loadingFailed",
listener: (message: InspectorNotification<Network.LoadingFailedEventDataType>) => void,
): this

#prependOnceListener(event: "Network.loadingFinished",
listener: (message: InspectorNotification<Network.LoadingFinishedEventDataType>) => void,
): this

#prependOnceListener(event: "NodeRuntime.waitingForDisconnect",
listener: () => void,
): this

This event is fired instead of Runtime.executionContextDestroyed when enabled. It is fired when the Node process finished all code execution and is waiting for all frontends to disconnect.

#prependOnceListener(event: "NodeRuntime.waitingForDebugger",
listener: () => void,
): this

This event is fired when the runtime is waiting for the debugger. For example, when inspector.waitingForDebugger is called

class Session

Constructors #

Methods #

Did you find what you needed?