Node

inspector

method Session.prototype.on

Overload 1

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

Parameters #

#event: string

#listener: (...args: any[]) => void

Return Type #

this

Overload 2

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

Emitted when any notification from the V8 Inspector is received.

Parameters #

#event: "inspectorNotification"

#listener: (message: InspectorNotification<object>) => void

Return Type #

this

Overload 3

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

Issued when new execution context is created.

Parameters #

#event: "Runtime.executionContextCreated"

#listener: (message: InspectorNotification<Runtime.ExecutionContextCreatedEventDataType>) => void

Return Type #

this

Overload 4

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

Issued when execution context is destroyed.

Parameters #

#event: "Runtime.executionContextDestroyed"

#listener: (message: InspectorNotification<Runtime.ExecutionContextDestroyedEventDataType>) => void

Return Type #

this

Overload 5

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

Issued when all executionContexts were cleared in browser

Parameters #

#event: "Runtime.executionContextsCleared"

#listener: () => void

Return Type #

this

Overload 6

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

Issued when exception was thrown and unhandled.

Parameters #

#event: "Runtime.exceptionThrown"

#listener: (message: InspectorNotification<Runtime.ExceptionThrownEventDataType>) => void

Return Type #

this

Overload 7

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

Issued when unhandled exception was revoked.

Parameters #

#event: "Runtime.exceptionRevoked"

#listener: (message: InspectorNotification<Runtime.ExceptionRevokedEventDataType>) => void

Return Type #

this

Overload 8

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

Issued when console API was called.

Parameters #

#event: "Runtime.consoleAPICalled"

#listener: (message: InspectorNotification<Runtime.ConsoleAPICalledEventDataType>) => void

Return Type #

this

Overload 9

#Session.prototype.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).

Parameters #

#event: "Runtime.inspectRequested"

#listener: (message: InspectorNotification<Runtime.InspectRequestedEventDataType>) => void

Return Type #

this

Overload 10

#Session.prototype.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.

Parameters #

#event: "Debugger.scriptParsed"

#listener: (message: InspectorNotification<Debugger.ScriptParsedEventDataType>) => void

Return Type #

this

Overload 11

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

Fired when virtual machine fails to parse the script.

Parameters #

#event: "Debugger.scriptFailedToParse"

#listener: (message: InspectorNotification<Debugger.ScriptFailedToParseEventDataType>) => void

Return Type #

this

Overload 12

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

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

Parameters #

#event: "Debugger.breakpointResolved"

#listener: (message: InspectorNotification<Debugger.BreakpointResolvedEventDataType>) => void

Return Type #

this

Overload 13

#Session.prototype.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.

Parameters #

#event: "Debugger.paused"

#listener: (message: InspectorNotification<Debugger.PausedEventDataType>) => void

Return Type #

this

Overload 14

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

Fired when the virtual machine resumed execution.

Parameters #

#event: "Debugger.resumed"

#listener: () => void

Return Type #

this

Overload 15

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

Issued when new console message is added.

Parameters #

#event: "Console.messageAdded"

#listener: (message: InspectorNotification<Console.MessageAddedEventDataType>) => void

Return Type #

this

Overload 16

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

#Session.prototype.on(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.

Parameters #

#event: "HeapProfiler.lastSeenObjectId"

#listener: (message: InspectorNotification<HeapProfiler.LastSeenObjectIdEventDataType>) => void

Return Type #

this

Overload 22

#Session.prototype.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

Parameters #

#event: "HeapProfiler.heapStatsUpdate"

#listener: (message: InspectorNotification<HeapProfiler.HeapStatsUpdateEventDataType>) => void

Return Type #

this

Overload 23

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

Contains an bucket of collected trace events.

Parameters #

#event: "NodeTracing.dataCollected"

#listener: (message: InspectorNotification<NodeTracing.DataCollectedEventDataType>) => void

Return Type #

this

Overload 24

#Session.prototype.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.

Parameters #

#event: "NodeTracing.tracingComplete"

#listener: () => void

Return Type #

this

Overload 25

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

Issued when attached to a worker.

Parameters #

#event: "NodeWorker.attachedToWorker"

#listener: (message: InspectorNotification<NodeWorker.AttachedToWorkerEventDataType>) => void

Return Type #

this

Overload 26

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

Issued when detached from the worker.

Parameters #

#event: "NodeWorker.detachedFromWorker"

#listener: (message: InspectorNotification<NodeWorker.DetachedFromWorkerEventDataType>) => void

Return Type #

this

Overload 27

#Session.prototype.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).

Parameters #

#event: "NodeWorker.receivedMessageFromWorker"

#listener: (message: InspectorNotification<NodeWorker.ReceivedMessageFromWorkerEventDataType>) => void

Return Type #

this

Overload 28

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

Fired when page is about to send HTTP request.

Parameters #

#event: "Network.requestWillBeSent"

#listener: (message: InspectorNotification<Network.RequestWillBeSentEventDataType>) => void

Return Type #

this

Overload 29

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

#Session.prototype.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.

Parameters #

#event: "NodeRuntime.waitingForDisconnect"

#listener: () => void

Return Type #

this

Overload 33

#Session.prototype.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

Parameters #

#event: "NodeRuntime.waitingForDebugger"

#listener: () => void

Return Type #

this