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 Jump to heading

new

Jump to heading#Session()

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 Jump to heading

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

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

Emitted when any notification from the V8 Inspector is received.

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

Issued when new execution context is created.

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

Issued when execution context is destroyed.

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

Issued when all executionContexts were cleared in browser

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

Issued when exception was thrown and unhandled.

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

Issued when unhandled exception was revoked.

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

Issued when console API was called.

Jump to heading#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).

Jump to heading#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.

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

Fired when virtual machine fails to parse the script.

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

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

Jump to heading#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.

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

Fired when the virtual machine resumed execution.

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

Issued when new console message is added.

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

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

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

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

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

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

Jump to heading#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.

Jump to heading#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

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

Contains an bucket of collected trace events.

Jump to heading#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.

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

Issued when attached to a worker.

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

Issued when detached from the worker.

Jump to heading#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).

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

Fired when page is about to send HTTP request.

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

Fired when HTTP response is available.

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

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

Jump to heading#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.

Jump to heading#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

Jump to heading#connect(): void

Connects a session to the inspector back-end.

Jump to heading#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.

Jump to heading#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.

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

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

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

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

Jump to heading#emit(event: "Runtime.executionContextsCleared"): boolean

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

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

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

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

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

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

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

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

Jump to heading#emit(event: "Debugger.resumed"): boolean

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

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

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

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

Jump to heading#emit(event: "HeapProfiler.resetProfiles"): boolean

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

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

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

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

Jump to heading#emit(event: "NodeTracing.tracingComplete"): boolean

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

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

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

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

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

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

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

Jump to heading#emit(event: "NodeRuntime.waitingForDisconnect"): boolean

Jump to heading#emit(event: "NodeRuntime.waitingForDebugger"): boolean

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

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

Emitted when any notification from the V8 Inspector is received.

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

Issued when new execution context is created.

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

Issued when execution context is destroyed.

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

Issued when all executionContexts were cleared in browser

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

Issued when exception was thrown and unhandled.

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

Issued when unhandled exception was revoked.

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

Issued when console API was called.

Jump to heading#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).

Jump to heading#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.

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

Fired when virtual machine fails to parse the script.

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

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

Jump to heading#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.

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

Fired when the virtual machine resumed execution.

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

Issued when new console message is added.

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

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

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

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

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

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

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

Jump to heading#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

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

Contains an bucket of collected trace events.

Jump to heading#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.

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

Issued when attached to a worker.

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

Issued when detached from the worker.

Jump to heading#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).

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

Fired when page is about to send HTTP request.

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

Fired when HTTP response is available.

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

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

Jump to heading#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.

Jump to heading#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

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

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

Emitted when any notification from the V8 Inspector is received.

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

Issued when new execution context is created.

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

Issued when execution context is destroyed.

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

Issued when all executionContexts were cleared in browser

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

Issued when exception was thrown and unhandled.

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

Issued when unhandled exception was revoked.

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

Issued when console API was called.

Jump to heading#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).

Jump to heading#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.

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

Fired when virtual machine fails to parse the script.

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

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

Jump to heading#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.

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

Fired when the virtual machine resumed execution.

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

Issued when new console message is added.

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

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

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

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

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

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

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

Jump to heading#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

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

Contains an bucket of collected trace events.

Jump to heading#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.

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

Issued when attached to a worker.

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

Issued when detached from the worker.

Jump to heading#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).

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

Fired when page is about to send HTTP request.

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

Fired when HTTP response is available.

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

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

Jump to heading#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.

Jump to heading#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

Jump to heading#post(method: string,
params?: object,
): Promise<void>

Posts a message to the inspector back-end.

import { Session } from 'node:inspector/promises';
try {
  const session = new Session();
  session.connect();
  const result = await session.post('Runtime.evaluate', { expression: '2 + 2' });
  console.log(result);
} catch (error) {
  console.error(error);
}
// Output: { result: { 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.

Jump to heading#post(method: "Schema.getDomains"): Promise<Schema.GetDomainsReturnType>

Returns supported domains.

Jump to heading#post(method: "Runtime.evaluate",
params?: Runtime.EvaluateParameterType,
): Promise<Runtime.EvaluateReturnType>

Evaluates expression on global object.

Jump to heading#post(method: "Runtime.awaitPromise",
params?: Runtime.AwaitPromiseParameterType,
): Promise<Runtime.AwaitPromiseReturnType>

Add handler to promise with given promise object id.

Jump to heading#post(method: "Runtime.callFunctionOn",
params?: Runtime.CallFunctionOnParameterType,
): Promise<Runtime.CallFunctionOnReturnType>

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

Jump to heading#post(method: "Runtime.getProperties",
params?: Runtime.GetPropertiesParameterType,
): Promise<Runtime.GetPropertiesReturnType>

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

Jump to heading#post(method: "Runtime.releaseObject",
params?: Runtime.ReleaseObjectParameterType,
): Promise<void>

Releases remote object with given id.

Jump to heading#post(method: "Runtime.releaseObjectGroup",
params?: Runtime.ReleaseObjectGroupParameterType,
): Promise<void>

Releases all remote objects that belong to a given group.

Jump to heading#post(method: "Runtime.runIfWaitingForDebugger"): Promise<void>

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

Jump to heading#post(method: "Runtime.enable"): Promise<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.

Jump to heading#post(method: "Runtime.disable"): Promise<void>

Disables reporting of execution contexts creation.

Jump to heading#post(method: "Runtime.discardConsoleEntries"): Promise<void>

Discards collected exceptions and console API calls.

Jump to heading#post(method: "Runtime.setCustomObjectFormatterEnabled",
params?: Runtime.SetCustomObjectFormatterEnabledParameterType,
): Promise<void>

Jump to heading#post(method: "Runtime.compileScript",
params?: Runtime.CompileScriptParameterType,
): Promise<Runtime.CompileScriptReturnType>

Compiles expression.

Jump to heading#post(method: "Runtime.runScript",
params?: Runtime.RunScriptParameterType,
): Promise<Runtime.RunScriptReturnType>

Runs script with given id in a given context.

Jump to heading#post(method: "Runtime.queryObjects",
params?: Runtime.QueryObjectsParameterType,
): Promise<Runtime.QueryObjectsReturnType>

Jump to heading#post(method: "Runtime.globalLexicalScopeNames",
params?: Runtime.GlobalLexicalScopeNamesParameterType,
): Promise<Runtime.GlobalLexicalScopeNamesReturnType>

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

Jump to heading#post(method: "Debugger.enable"): Promise<Debugger.EnableReturnType>

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

Jump to heading#post(method: "Debugger.disable"): Promise<void>

Disables debugger for given page.

Jump to heading#post(method: "Debugger.setBreakpointsActive",
params?: Debugger.SetBreakpointsActiveParameterType,
): Promise<void>

Activates / deactivates all breakpoints on the page.

Jump to heading#post(method: "Debugger.setSkipAllPauses",
params?: Debugger.SetSkipAllPausesParameterType,
): Promise<void>

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

Jump to heading#post(method: "Debugger.setBreakpointByUrl",
params?: Debugger.SetBreakpointByUrlParameterType,
): Promise<Debugger.SetBreakpointByUrlReturnType>

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.

Jump to heading#post(method: "Debugger.setBreakpoint",
params?: Debugger.SetBreakpointParameterType,
): Promise<Debugger.SetBreakpointReturnType>

Sets JavaScript breakpoint at a given location.

Jump to heading#post(method: "Debugger.removeBreakpoint",
params?: Debugger.RemoveBreakpointParameterType,
): Promise<void>

Removes JavaScript breakpoint.

Jump to heading#post(method: "Debugger.getPossibleBreakpoints",
params?: Debugger.GetPossibleBreakpointsParameterType,
): Promise<Debugger.GetPossibleBreakpointsReturnType>

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

Jump to heading#post(method: "Debugger.continueToLocation",
params?: Debugger.ContinueToLocationParameterType,
): Promise<void>

Continues execution until specific location is reached.

Jump to heading#post(method: "Debugger.pauseOnAsyncCall",
params?: Debugger.PauseOnAsyncCallParameterType,
): Promise<void>

Jump to heading#post(method: "Debugger.stepOver"): Promise<void>

Steps over the statement.

Jump to heading#post(method: "Debugger.stepInto",
params?: Debugger.StepIntoParameterType,
): Promise<void>

Steps into the function call.

Jump to heading#post(method: "Debugger.stepOut"): Promise<void>

Steps out of the function call.

Jump to heading#post(method: "Debugger.pause"): Promise<void>

Stops on the next JavaScript statement.

Jump to heading#post(method: "Debugger.scheduleStepIntoAsync"): Promise<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.

Jump to heading#post(method: "Debugger.resume"): Promise<void>

Resumes JavaScript execution.

Jump to heading#post(method: "Debugger.getStackTrace",
params?: Debugger.GetStackTraceParameterType,
): Promise<Debugger.GetStackTraceReturnType>

Returns stack trace with given stackTraceId.

Jump to heading#post(method: "Debugger.searchInContent",
params?: Debugger.SearchInContentParameterType,
): Promise<Debugger.SearchInContentReturnType>

Searches for given string in script content.

Jump to heading#post(method: "Debugger.setScriptSource",
params?: Debugger.SetScriptSourceParameterType,
): Promise<Debugger.SetScriptSourceReturnType>

Edits JavaScript source live.

Jump to heading#post(method: "Debugger.restartFrame",
params?: Debugger.RestartFrameParameterType,
): Promise<Debugger.RestartFrameReturnType>

Restarts particular call frame from the beginning.

Jump to heading#post(method: "Debugger.getScriptSource",
params?: Debugger.GetScriptSourceParameterType,
): Promise<Debugger.GetScriptSourceReturnType>

Returns source for the script with given id.

Jump to heading#post(method: "Debugger.setPauseOnExceptions",
params?: Debugger.SetPauseOnExceptionsParameterType,
): Promise<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.

Jump to heading#post(method: "Debugger.evaluateOnCallFrame",
params?: Debugger.EvaluateOnCallFrameParameterType,
): Promise<Debugger.EvaluateOnCallFrameReturnType>

Evaluates expression on a given call frame.

Jump to heading#post(method: "Debugger.setVariableValue",
params?: Debugger.SetVariableValueParameterType,
): Promise<void>

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

Jump to heading#post(method: "Debugger.setReturnValue",
params?: Debugger.SetReturnValueParameterType,
): Promise<void>

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

Jump to heading#post(method: "Debugger.setAsyncCallStackDepth",
params?: Debugger.SetAsyncCallStackDepthParameterType,
): Promise<void>

Enables or disables async call stacks tracking.

Jump to heading#post(method: "Debugger.setBlackboxPatterns",
params?: Debugger.SetBlackboxPatternsParameterType,
): Promise<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.

Jump to heading#post(method: "Debugger.setBlackboxedRanges",
params?: Debugger.SetBlackboxedRangesParameterType,
): Promise<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.

Jump to heading#post(method: "Console.enable"): Promise<void>

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

Jump to heading#post(method: "Console.disable"): Promise<void>

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

Jump to heading#post(method: "Console.clearMessages"): Promise<void>

Does nothing.

Jump to heading#post(method: "Profiler.enable"): Promise<void>

Jump to heading#post(method: "Profiler.disable"): Promise<void>

Jump to heading#post(method: "Profiler.setSamplingInterval",
params?: Profiler.SetSamplingIntervalParameterType,
): Promise<void>

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

Jump to heading#post(method: "Profiler.start"): Promise<void>

Jump to heading#post(method: "Profiler.stop"): Promise<Profiler.StopReturnType>

Jump to heading#post(method: "Profiler.startPreciseCoverage",
params?: Profiler.StartPreciseCoverageParameterType,
): Promise<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.

Jump to heading#post(method: "Profiler.stopPreciseCoverage"): Promise<void>

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

Jump to heading#post(method: "Profiler.takePreciseCoverage"): Promise<Profiler.TakePreciseCoverageReturnType>

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

Jump to heading#post(method: "Profiler.getBestEffortCoverage"): Promise<Profiler.GetBestEffortCoverageReturnType>

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

Jump to heading#post(method: "HeapProfiler.enable"): Promise<void>

Jump to heading#post(method: "HeapProfiler.disable"): Promise<void>

Jump to heading#post(method: "HeapProfiler.startTrackingHeapObjects",
params?: HeapProfiler.StartTrackingHeapObjectsParameterType,
): Promise<void>

Jump to heading#post(method: "HeapProfiler.stopTrackingHeapObjects",
params?: HeapProfiler.StopTrackingHeapObjectsParameterType,
): Promise<void>

Jump to heading#post(method: "HeapProfiler.takeHeapSnapshot",
params?: HeapProfiler.TakeHeapSnapshotParameterType,
): Promise<void>

Jump to heading#post(method: "HeapProfiler.collectGarbage"): Promise<void>

Jump to heading#post(method: "HeapProfiler.getObjectByHeapObjectId",
params?: HeapProfiler.GetObjectByHeapObjectIdParameterType,
): Promise<HeapProfiler.GetObjectByHeapObjectIdReturnType>

Jump to heading#post(method: "HeapProfiler.addInspectedHeapObject",
params?: HeapProfiler.AddInspectedHeapObjectParameterType,
): Promise<void>

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

Jump to heading#post(method: "HeapProfiler.getHeapObjectId",
params?: HeapProfiler.GetHeapObjectIdParameterType,
): Promise<HeapProfiler.GetHeapObjectIdReturnType>

Jump to heading#post(method: "HeapProfiler.startSampling",
params?: HeapProfiler.StartSamplingParameterType,
): Promise<void>

Jump to heading#post(method: "HeapProfiler.stopSampling"): Promise<HeapProfiler.StopSamplingReturnType>

Jump to heading#post(method: "HeapProfiler.getSamplingProfile"): Promise<HeapProfiler.GetSamplingProfileReturnType>

Jump to heading#post(method: "NodeTracing.getCategories"): Promise<NodeTracing.GetCategoriesReturnType>

Gets supported tracing categories.

Jump to heading#post(method: "NodeTracing.start",
params?: NodeTracing.StartParameterType,
): Promise<void>

Start trace events collection.

Jump to heading#post(method: "NodeTracing.stop"): Promise<void>

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

Jump to heading#post(method: "NodeWorker.sendMessageToWorker",
params?: NodeWorker.SendMessageToWorkerParameterType,
): Promise<void>

Sends protocol message over session with given id.

Jump to heading#post(method: "NodeWorker.enable",
params?: NodeWorker.EnableParameterType,
): Promise<void>

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

Jump to heading#post(method: "NodeWorker.disable"): Promise<void>

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

Jump to heading#post(method: "NodeWorker.detach",
params?: NodeWorker.DetachParameterType,
): Promise<void>

Detached from the worker with given sessionId.

Jump to heading#post(method: "Network.disable"): Promise<void>

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

Jump to heading#post(method: "Network.enable"): Promise<void>

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

Jump to heading#post(method: "NodeRuntime.enable"): Promise<void>

Enable the NodeRuntime events except by NodeRuntime.waitingForDisconnect.

Jump to heading#post(method: "NodeRuntime.disable"): Promise<void>

Disable NodeRuntime events

Jump to heading#post(method: "NodeRuntime.notifyWhenWaitingForDisconnect",
params?: NodeRuntime.NotifyWhenWaitingForDisconnectParameterType,
): Promise<void>

Enable the NodeRuntime.waitingForDisconnect.

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

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

Emitted when any notification from the V8 Inspector is received.

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

Issued when new execution context is created.

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

Issued when execution context is destroyed.

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

Issued when all executionContexts were cleared in browser

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

Issued when exception was thrown and unhandled.

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

Issued when unhandled exception was revoked.

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

Issued when console API was called.

Jump to heading#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).

Jump to heading#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.

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

Fired when virtual machine fails to parse the script.

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

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

Jump to heading#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.

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

Fired when the virtual machine resumed execution.

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

Issued when new console message is added.

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

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

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

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

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

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

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

Jump to heading#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

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

Contains an bucket of collected trace events.

Jump to heading#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.

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

Issued when attached to a worker.

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

Issued when detached from the worker.

Jump to heading#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).

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

Fired when page is about to send HTTP request.

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

Fired when HTTP response is available.

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

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

Jump to heading#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.

Jump to heading#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

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

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

Emitted when any notification from the V8 Inspector is received.

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

Issued when new execution context is created.

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

Issued when execution context is destroyed.

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

Issued when all executionContexts were cleared in browser

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

Issued when exception was thrown and unhandled.

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

Issued when unhandled exception was revoked.

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

Issued when console API was called.

Jump to heading#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).

Jump to heading#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.

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

Fired when virtual machine fails to parse the script.

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

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

Jump to heading#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.

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

Fired when the virtual machine resumed execution.

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

Issued when new console message is added.

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

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

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

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

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

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

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

Jump to heading#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

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

Contains an bucket of collected trace events.

Jump to heading#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.

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

Issued when attached to a worker.

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

Issued when detached from the worker.

Jump to heading#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).

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

Fired when page is about to send HTTP request.

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

Fired when HTTP response is available.

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

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

Jump to heading#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.

Jump to heading#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

Session

Constructors Jump to heading#

Methods Jump to heading#

Constructors Jump to heading

Methods Jump to heading