class

inspector.Session

class Session

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

[events.captureRejectionSymbol](
error: Error,
event: string | symbol,
...args: any[]
): void;
The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').
import { EventEmitter, captureRejectionSymbol } from 'node:events'; class MyClass extends EventEmitter { constructor() { super({ captureRejections: true }); } [captureRejectionSymbol](err, event, ...args) { console.log('rejection happened for', event, 'with', err, ...args); this.destroy(err); } destroy(err) { // Tear the resource down here. } }
addListener(
event: string,
listener: (...args: any[]) => void
): this;
Alias for emitter.on(eventName, listener).
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<ExecutionContextCreatedEventDataType>) => void
): this;
Issued when new execution context is created.
addListener(
event: 'Runtime.executionContextDestroyed',
listener: (message: InspectorNotification<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<ExceptionThrownEventDataType>) => void
): this;
Issued when exception was thrown and unhandled.
addListener(
event: 'Runtime.exceptionRevoked',
listener: (message: InspectorNotification<ExceptionRevokedEventDataType>) => void
): this;
Issued when unhandled exception was revoked.
addListener(
event: 'Runtime.consoleAPICalled',
listener: (message: InspectorNotification<ConsoleAPICalledEventDataType>) => void
): this;
Issued when console API was called.
addListener(
event: 'Runtime.inspectRequested',
listener: (message: InspectorNotification<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<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<ScriptFailedToParseEventDataType>) => void
): this;
Fired when virtual machine fails to parse the script.
addListener(
event: 'Debugger.breakpointResolved',
listener: (message: InspectorNotification<BreakpointResolvedEventDataType>) => void
): this;
Fired when breakpoint is resolved to an actual script and location.
addListener(
event: 'Debugger.paused',
listener: (message: InspectorNotification<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<MessageAddedEventDataType>) => void
): this;
Issued when new console message is added.
addListener(
event: 'Profiler.consoleProfileStarted',
listener: (message: InspectorNotification<ConsoleProfileStartedEventDataType>) => void
): this;
Sent when new profile recording is started using console.profile() call.
addListener(
event: 'Profiler.consoleProfileFinished',
listener: (message: InspectorNotification<ConsoleProfileFinishedEventDataType>) => void
): this;
addListener(
event: 'HeapProfiler.addHeapSnapshotChunk',
listener: (message: InspectorNotification<AddHeapSnapshotChunkEventDataType>) => void
): this;
addListener(
event: 'HeapProfiler.resetProfiles',
listener: () => void
): this;
addListener(
event: 'HeapProfiler.reportHeapSnapshotProgress',
listener: (message: InspectorNotification<ReportHeapSnapshotProgressEventDataType>) => void
): this;
addListener(
event: 'HeapProfiler.lastSeenObjectId',
listener: (message: InspectorNotification<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<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<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<AttachedToWorkerEventDataType>) => void
): this;
Issued when attached to a worker.
addListener(
event: 'NodeWorker.detachedFromWorker',
listener: (message: InspectorNotification<DetachedFromWorkerEventDataType>) => void
): this;
Issued when detached from the worker.
addListener(
event: 'NodeWorker.receivedMessageFromWorker',
listener: (message: InspectorNotification<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<RequestWillBeSentEventDataType>) => void
): this;
Fired when page is about to send HTTP request.
addListener(
event: 'Network.responseReceived',
listener: (message: InspectorNotification<ResponseReceivedEventDataType>) => void
): this;
Fired when HTTP response is available.
addListener(
event: 'Network.loadingFailed',
listener: (message: InspectorNotification<LoadingFailedEventDataType>) => void
): this;
addListener(
event: 'Network.loadingFinished',
listener: (message: InspectorNotification<LoadingFinishedEventDataType>) => void
): this;
addListener(
event: 'Network.dataReceived',
listener: (message: InspectorNotification<DataReceivedEventDataType>) => void
): this;
Fired when data chunk was received over the network.
addListener(
event: 'Network.webSocketCreated',
listener: (message: InspectorNotification<WebSocketCreatedEventDataType>) => void
): this;
Fired upon WebSocket creation.
addListener(
event: 'Network.webSocketClosed',
listener: (message: InspectorNotification<WebSocketClosedEventDataType>) => void
): this;
Fired when WebSocket is closed.
addListener(
event: 'Network.webSocketHandshakeResponseReceived',
listener: (message: InspectorNotification<WebSocketHandshakeResponseReceivedEventDataType>) => void
): this;
Fired when WebSocket handshake response becomes available.
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
addListener(
event: 'Target.targetCreated',
listener: (message: InspectorNotification<TargetCreatedEventDataType>) => void
): this;
addListener(
event: 'Target.attachedToTarget',
listener: (message: InspectorNotification<AttachedToTargetEventDataType>) => void
): this;
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;
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events'; const myEmitter = new EventEmitter(); // First listener myEmitter.on('event', function firstListener() { console.log('Helloooo! first listener'); }); // Second listener myEmitter.on('event', function secondListener(arg1, arg2) { console.log(`event with parameters ${arg1}, ${arg2} in second listener`); }); // Third listener myEmitter.on('event', function thirdListener(...args) { const parameters = args.join(', '); console.log(`event with parameters ${parameters} in third listener`); }); console.log(myEmitter.listeners('event')); myEmitter.emit('event', 1, 2, 3, 4, 5); // Prints: // [ // [Function: firstListener], // [Function: secondListener], // [Function: thirdListener] // ] // Helloooo! first listener // event with parameters 1, 2 in second listener // event with parameters 1, 2, 3, 4, 5 in third listener
emit(
event: 'inspectorNotification',
message: InspectorNotification<object>
): boolean;
emit(
event: 'Runtime.executionContextCreated',
message: InspectorNotification<ExecutionContextCreatedEventDataType>
): boolean;
emit(
event: 'Runtime.executionContextDestroyed',
message: InspectorNotification<ExecutionContextDestroyedEventDataType>
): boolean;
emit(
event: 'Runtime.executionContextsCleared'
): boolean;
emit(
event: 'Runtime.exceptionThrown',
message: InspectorNotification<ExceptionThrownEventDataType>
): boolean;
emit(
event: 'Runtime.exceptionRevoked',
message: InspectorNotification<ExceptionRevokedEventDataType>
): boolean;
emit(
event: 'Runtime.consoleAPICalled',
message: InspectorNotification<ConsoleAPICalledEventDataType>
): boolean;
emit(
event: 'Runtime.inspectRequested',
message: InspectorNotification<InspectRequestedEventDataType>
): boolean;
emit(
event: 'Debugger.scriptParsed',
message: InspectorNotification<ScriptParsedEventDataType>
): boolean;
emit(
event: 'Debugger.scriptFailedToParse',
message: InspectorNotification<ScriptFailedToParseEventDataType>
): boolean;
emit(
event: 'Debugger.breakpointResolved',
message: InspectorNotification<BreakpointResolvedEventDataType>
): boolean;
emit(
event: 'Debugger.paused',
message: InspectorNotification<PausedEventDataType>
): boolean;
emit(
event: 'Debugger.resumed'
): boolean;
emit(
event: 'Console.messageAdded',
message: InspectorNotification<MessageAddedEventDataType>
): boolean;
emit(
event: 'Profiler.consoleProfileStarted',
message: InspectorNotification<ConsoleProfileStartedEventDataType>
): boolean;
emit(
event: 'Profiler.consoleProfileFinished',
message: InspectorNotification<ConsoleProfileFinishedEventDataType>
): boolean;
emit(
event: 'HeapProfiler.addHeapSnapshotChunk',
message: InspectorNotification<AddHeapSnapshotChunkEventDataType>
): boolean;
emit(
event: 'HeapProfiler.resetProfiles'
): boolean;
emit(
event: 'HeapProfiler.reportHeapSnapshotProgress',
message: InspectorNotification<ReportHeapSnapshotProgressEventDataType>
): boolean;
emit(
event: 'HeapProfiler.lastSeenObjectId',
message: InspectorNotification<LastSeenObjectIdEventDataType>
): boolean;
emit(
event: 'HeapProfiler.heapStatsUpdate',
message: InspectorNotification<HeapStatsUpdateEventDataType>
): boolean;
emit(
event: 'NodeTracing.dataCollected',
message: InspectorNotification<DataCollectedEventDataType>
): boolean;
emit(
event: 'NodeTracing.tracingComplete'
): boolean;
emit(
event: 'NodeWorker.attachedToWorker',
message: InspectorNotification<AttachedToWorkerEventDataType>
): boolean;
emit(
event: 'NodeWorker.detachedFromWorker',
message: InspectorNotification<DetachedFromWorkerEventDataType>
): boolean;
emit(
event: 'NodeWorker.receivedMessageFromWorker',
message: InspectorNotification<ReceivedMessageFromWorkerEventDataType>
): boolean;
emit(
event: 'Network.requestWillBeSent',
message: InspectorNotification<RequestWillBeSentEventDataType>
): boolean;
emit(
event: 'Network.responseReceived',
message: InspectorNotification<ResponseReceivedEventDataType>
): boolean;
emit(
event: 'Network.loadingFailed',
message: InspectorNotification<LoadingFailedEventDataType>
): boolean;
emit(
event: 'Network.loadingFinished',
message: InspectorNotification<LoadingFinishedEventDataType>
): boolean;
emit(
event: 'Network.dataReceived',
message: InspectorNotification<DataReceivedEventDataType>
): boolean;
emit(
event: 'Network.webSocketCreated',
message: InspectorNotification<WebSocketCreatedEventDataType>
): boolean;
emit(
event: 'Network.webSocketClosed',
message: InspectorNotification<WebSocketClosedEventDataType>
): boolean;
emit(
event: 'Network.webSocketHandshakeResponseReceived',
message: InspectorNotification<WebSocketHandshakeResponseReceivedEventDataType>
): boolean;
emit(
event: 'NodeRuntime.waitingForDisconnect'
): boolean;
emit(
event: 'NodeRuntime.waitingForDebugger'
): boolean;
emit(
event: 'Target.targetCreated',
message: InspectorNotification<TargetCreatedEventDataType>
): boolean;
emit(
event: 'Target.attachedToTarget',
message: InspectorNotification<AttachedToTargetEventDataType>
): boolean;
eventNames(): string | symbol[];
Returns an array listing the events for which the emitter has registered listeners.
import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.on('foo', () => {}); myEE.on('bar', () => {}); const sym = Symbol('symbol'); myEE.on(sym, () => {}); console.log(myEE.eventNames()); // Prints: [ 'foo', 'bar', Symbol(symbol) ]
getMaxListeners(): number;
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.
listenerCount<E extends string | symbol>(
eventName: string | symbol,
listener?: (...args: any[]) => void
): number;
Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.
@param eventName
The name of the event being listened for
@param listener
The event handler function
listeners<E extends string | symbol>(
eventName: string | symbol
): (...args: any[]) => void[];
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]
off<E extends string | symbol>(
eventName: string | symbol,
listener: (...args: any[]) => void
): this;
Alias for emitter.removeListener().
on(
event: string,
listener: (...args: any[]) => void
): this;
Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
server.on('connection', (stream) => { console.log('someone connected!'); });
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.on('foo', () => console.log('a')); myEE.prependListener('foo', () => console.log('b')); myEE.emit('foo'); // Prints: // b // a
@param event
The name of the event.
@param listener
The callback function
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<ExecutionContextCreatedEventDataType>) => void
): this;
Issued when new execution context is created.
on(
event: 'Runtime.executionContextDestroyed',
listener: (message: InspectorNotification<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<ExceptionThrownEventDataType>) => void
): this;
Issued when exception was thrown and unhandled.
on(
event: 'Runtime.exceptionRevoked',
listener: (message: InspectorNotification<ExceptionRevokedEventDataType>) => void
): this;
Issued when unhandled exception was revoked.
on(
event: 'Runtime.consoleAPICalled',
listener: (message: InspectorNotification<ConsoleAPICalledEventDataType>) => void
): this;
Issued when console API was called.
on(
event: 'Runtime.inspectRequested',
listener: (message: InspectorNotification<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<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<ScriptFailedToParseEventDataType>) => void
): this;
Fired when virtual machine fails to parse the script.
on(
event: 'Debugger.breakpointResolved',
listener: (message: InspectorNotification<BreakpointResolvedEventDataType>) => void
): this;
Fired when breakpoint is resolved to an actual script and location.
on(
event: 'Debugger.paused',
listener: (message: InspectorNotification<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<MessageAddedEventDataType>) => void
): this;
Issued when new console message is added.
on(
event: 'Profiler.consoleProfileStarted',
listener: (message: InspectorNotification<ConsoleProfileStartedEventDataType>) => void
): this;
Sent when new profile recording is started using console.profile() call.
on(
event: 'Profiler.consoleProfileFinished',
listener: (message: InspectorNotification<ConsoleProfileFinishedEventDataType>) => void
): this;
on(
event: 'HeapProfiler.addHeapSnapshotChunk',
listener: (message: InspectorNotification<AddHeapSnapshotChunkEventDataType>) => void
): this;
on(
event: 'HeapProfiler.resetProfiles',
listener: () => void
): this;
on(
event: 'HeapProfiler.reportHeapSnapshotProgress',
listener: (message: InspectorNotification<ReportHeapSnapshotProgressEventDataType>) => void
): this;
on(
event: 'HeapProfiler.lastSeenObjectId',
listener: (message: InspectorNotification<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.
on(
event: 'HeapProfiler.heapStatsUpdate',
listener: (message: InspectorNotification<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<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<AttachedToWorkerEventDataType>) => void
): this;
Issued when attached to a worker.
on(
event: 'NodeWorker.detachedFromWorker',
listener: (message: InspectorNotification<DetachedFromWorkerEventDataType>) => void
): this;
Issued when detached from the worker.
on(
event: 'NodeWorker.receivedMessageFromWorker',
listener: (message: InspectorNotification<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<RequestWillBeSentEventDataType>) => void
): this;
Fired when page is about to send HTTP request.
on(
event: 'Network.responseReceived',
listener: (message: InspectorNotification<ResponseReceivedEventDataType>) => void
): this;
Fired when HTTP response is available.
on(
event: 'Network.loadingFailed',
listener: (message: InspectorNotification<LoadingFailedEventDataType>) => void
): this;
on(
event: 'Network.loadingFinished',
listener: (message: InspectorNotification<LoadingFinishedEventDataType>) => void
): this;
on(
event: 'Network.dataReceived',
listener: (message: InspectorNotification<DataReceivedEventDataType>) => void
): this;
Fired when data chunk was received over the network.
on(
event: 'Network.webSocketCreated',
listener: (message: InspectorNotification<WebSocketCreatedEventDataType>) => void
): this;
Fired upon WebSocket creation.
on(
event: 'Network.webSocketClosed',
listener: (message: InspectorNotification<WebSocketClosedEventDataType>) => void
): this;
Fired when WebSocket is closed.
on(
event: 'Network.webSocketHandshakeResponseReceived',
listener: (message: InspectorNotification<WebSocketHandshakeResponseReceivedEventDataType>) => void
): this;
Fired when WebSocket handshake response becomes available.
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
on(
event: 'Target.targetCreated',
listener: (message: InspectorNotification<TargetCreatedEventDataType>) => void
): this;
on(
event: 'Target.attachedToTarget',
listener: (message: InspectorNotification<AttachedToTargetEventDataType>) => void
): this;
once(
event: string,
listener: (...args: any[]) => void
): this;
Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => { console.log('Ah, we have our first user!'); });
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.once('foo', () => console.log('a')); myEE.prependOnceListener('foo', () => console.log('b')); myEE.emit('foo'); // Prints: // b // a
@param event
The name of the event.
@param listener
The callback function
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<ExecutionContextCreatedEventDataType>) => void
): this;
Issued when new execution context is created.
once(
event: 'Runtime.executionContextDestroyed',
listener: (message: InspectorNotification<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<ExceptionThrownEventDataType>) => void
): this;
Issued when exception was thrown and unhandled.
once(
event: 'Runtime.exceptionRevoked',
listener: (message: InspectorNotification<ExceptionRevokedEventDataType>) => void
): this;
Issued when unhandled exception was revoked.
once(
event: 'Runtime.consoleAPICalled',
listener: (message: InspectorNotification<ConsoleAPICalledEventDataType>) => void
): this;
Issued when console API was called.
once(
event: 'Runtime.inspectRequested',
listener: (message: InspectorNotification<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<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<ScriptFailedToParseEventDataType>) => void
): this;
Fired when virtual machine fails to parse the script.
once(
event: 'Debugger.breakpointResolved',
listener: (message: InspectorNotification<BreakpointResolvedEventDataType>) => void
): this;
Fired when breakpoint is resolved to an actual script and location.
once(
event: 'Debugger.paused',
listener: (message: InspectorNotification<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<MessageAddedEventDataType>) => void
): this;
Issued when new console message is added.
once(
event: 'Profiler.consoleProfileStarted',
listener: (message: InspectorNotification<ConsoleProfileStartedEventDataType>) => void
): this;
Sent when new profile recording is started using console.profile() call.
once(
event: 'Profiler.consoleProfileFinished',
listener: (message: InspectorNotification<ConsoleProfileFinishedEventDataType>) => void
): this;
once(
event: 'HeapProfiler.addHeapSnapshotChunk',
listener: (message: InspectorNotification<AddHeapSnapshotChunkEventDataType>) => void
): this;
once(
event: 'HeapProfiler.resetProfiles',
listener: () => void
): this;
once(
event: 'HeapProfiler.reportHeapSnapshotProgress',
listener: (message: InspectorNotification<ReportHeapSnapshotProgressEventDataType>) => void
): this;
once(
event: 'HeapProfiler.lastSeenObjectId',
listener: (message: InspectorNotification<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.
once(
event: 'HeapProfiler.heapStatsUpdate',
listener: (message: InspectorNotification<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<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<AttachedToWorkerEventDataType>) => void
): this;
Issued when attached to a worker.
once(
event: 'NodeWorker.detachedFromWorker',
listener: (message: InspectorNotification<DetachedFromWorkerEventDataType>) => void
): this;
Issued when detached from the worker.
once(
event: 'NodeWorker.receivedMessageFromWorker',
listener: (message: InspectorNotification<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<RequestWillBeSentEventDataType>) => void
): this;
Fired when page is about to send HTTP request.
once(
event: 'Network.responseReceived',
listener: (message: InspectorNotification<ResponseReceivedEventDataType>) => void
): this;
Fired when HTTP response is available.
once(
event: 'Network.loadingFailed',
listener: (message: InspectorNotification<LoadingFailedEventDataType>) => void
): this;
once(
event: 'Network.loadingFinished',
listener: (message: InspectorNotification<LoadingFinishedEventDataType>) => void
): this;
once(
event: 'Network.dataReceived',
listener: (message: InspectorNotification<DataReceivedEventDataType>) => void
): this;
Fired when data chunk was received over the network.
once(
event: 'Network.webSocketCreated',
listener: (message: InspectorNotification<WebSocketCreatedEventDataType>) => void
): this;
Fired upon WebSocket creation.
once(
event: 'Network.webSocketClosed',
listener: (message: InspectorNotification<WebSocketClosedEventDataType>) => void
): this;
Fired when WebSocket is closed.
once(
event: 'Network.webSocketHandshakeResponseReceived',
listener: (message: InspectorNotification<WebSocketHandshakeResponseReceivedEventDataType>) => void
): this;
Fired when WebSocket handshake response becomes available.
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
once(
event: 'Target.targetCreated',
listener: (message: InspectorNotification<TargetCreatedEventDataType>) => void
): this;
once(
event: 'Target.attachedToTarget',
listener: (message: InspectorNotification<AttachedToTargetEventDataType>) => void
): this;
post(
method: string,
callback?: (err: null | Error, 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: null | Error, params?: object) => void
): void;
post(
method: 'Schema.getDomains',
callback?: (err: null | Error, params: GetDomainsReturnType) => void
): void;
Returns supported domains.
post(
method: 'Runtime.evaluate',
params?: EvaluateParameterType,
callback?: (err: null | Error, params: EvaluateReturnType) => void
): void;
Evaluates expression on global object.
post(
method: 'Runtime.evaluate',
callback?: (err: null | Error, params: EvaluateReturnType) => void
): void;
post(
method: 'Runtime.awaitPromise',
params?: AwaitPromiseParameterType,
callback?: (err: null | Error, params: AwaitPromiseReturnType) => void
): void;
Add handler to promise with given promise object id.
post(
method: 'Runtime.awaitPromise',
callback?: (err: null | Error, params: AwaitPromiseReturnType) => void
): void;
post(
method: 'Runtime.callFunctionOn',
params?: CallFunctionOnParameterType,
callback?: (err: null | Error, params: 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: null | Error, params: CallFunctionOnReturnType) => void
): void;
post(
method: 'Runtime.getProperties',
params?: GetPropertiesParameterType,
callback?: (err: null | Error, params: 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: null | Error, params: GetPropertiesReturnType) => void
): void;
post(
method: 'Runtime.releaseObject',
params?: ReleaseObjectParameterType,
callback?: (err: null | Error) => void
): void;
Releases remote object with given id.
post(
method: 'Runtime.releaseObject',
callback?: (err: null | Error) => void
): void;
post(
method: 'Runtime.releaseObjectGroup',
params?: ReleaseObjectGroupParameterType,
callback?: (err: null | Error) => void
): void;
Releases all remote objects that belong to a given group.
post(
method: 'Runtime.releaseObjectGroup',
callback?: (err: null | Error) => void
): void;
post(
method: 'Runtime.runIfWaitingForDebugger',
callback?: (err: null | Error) => void
): void;
Tells inspected instance to run if it was waiting for debugger to attach.
post(
method: 'Runtime.enable',
callback?: (err: null | Error) => void
): void;
Enables reporting of execution contexts creation by means of <code>executionContextCreated</code> event. When the reporting gets enabled the event will be sent immediately for each existing execution context.
post(
method: 'Runtime.disable',
callback?: (err: null | Error) => void
): void;
Disables reporting of execution contexts creation.
post(
method: 'Runtime.discardConsoleEntries',
callback?: (err: null | Error) => void
): void;
Discards collected exceptions and console API calls.
post(
method: 'Runtime.setCustomObjectFormatterEnabled',
params?: SetCustomObjectFormatterEnabledParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'Runtime.setCustomObjectFormatterEnabled',
callback?: (err: null | Error) => void
): void;
post(
method: 'Runtime.compileScript',
params?: CompileScriptParameterType,
callback?: (err: null | Error, params: CompileScriptReturnType) => void
): void;
Compiles expression.
post(
method: 'Runtime.compileScript',
callback?: (err: null | Error, params: CompileScriptReturnType) => void
): void;
post(
method: 'Runtime.runScript',
params?: RunScriptParameterType,
callback?: (err: null | Error, params: RunScriptReturnType) => void
): void;
Runs script with given id in a given context.
post(
method: 'Runtime.runScript',
callback?: (err: null | Error, params: RunScriptReturnType) => void
): void;
post(
method: 'Runtime.queryObjects',
params?: QueryObjectsParameterType,
callback?: (err: null | Error, params: QueryObjectsReturnType) => void
): void;
post(
method: 'Runtime.queryObjects',
callback?: (err: null | Error, params: QueryObjectsReturnType) => void
): void;
post(
method: 'Runtime.globalLexicalScopeNames',
params?: GlobalLexicalScopeNamesParameterType,
callback?: (err: null | Error, params: GlobalLexicalScopeNamesReturnType) => void
): void;
Returns all let, const and class variables from global scope.
post(
method: 'Runtime.globalLexicalScopeNames',
callback?: (err: null | Error, params: GlobalLexicalScopeNamesReturnType) => void
): void;
post(
method: 'Debugger.enable',
callback?: (err: null | Error, params: 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: null | Error) => void
): void;
Disables debugger for given page.
post(
method: 'Debugger.setBreakpointsActive',
params?: SetBreakpointsActiveParameterType,
callback?: (err: null | Error) => void
): void;
Activates / deactivates all breakpoints on the page.
post(
method: 'Debugger.setBreakpointsActive',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.setSkipAllPauses',
params?: SetSkipAllPausesParameterType,
callback?: (err: null | Error) => void
): void;
Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
post(
method: 'Debugger.setSkipAllPauses',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.setBreakpointByUrl',
params?: SetBreakpointByUrlParameterType,
callback?: (err: null | Error, params: 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 <code>locations</code> property. Further matching script parsing will result in subsequent <code>breakpointResolved</code> events issued. This logical breakpoint will survive page reloads.
post(
method: 'Debugger.setBreakpointByUrl',
callback?: (err: null | Error, params: SetBreakpointByUrlReturnType) => void
): void;
post(
method: 'Debugger.setBreakpoint',
params?: SetBreakpointParameterType,
callback?: (err: null | Error, params: SetBreakpointReturnType) => void
): void;
Sets JavaScript breakpoint at a given location.
post(
method: 'Debugger.setBreakpoint',
callback?: (err: null | Error, params: SetBreakpointReturnType) => void
): void;
post(
method: 'Debugger.removeBreakpoint',
params?: RemoveBreakpointParameterType,
callback?: (err: null | Error) => void
): void;
Removes JavaScript breakpoint.
post(
method: 'Debugger.removeBreakpoint',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.getPossibleBreakpoints',
params?: GetPossibleBreakpointsParameterType,
callback?: (err: null | Error, params: 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: null | Error, params: GetPossibleBreakpointsReturnType) => void
): void;
post(
method: 'Debugger.continueToLocation',
params?: ContinueToLocationParameterType,
callback?: (err: null | Error) => void
): void;
Continues execution until specific location is reached.
post(
method: 'Debugger.continueToLocation',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.pauseOnAsyncCall',
params?: PauseOnAsyncCallParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.pauseOnAsyncCall',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.stepOver',
callback?: (err: null | Error) => void
): void;
Steps over the statement.
post(
method: 'Debugger.stepInto',
params?: StepIntoParameterType,
callback?: (err: null | Error) => void
): void;
Steps into the function call.
post(
method: 'Debugger.stepInto',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.stepOut',
callback?: (err: null | Error) => void
): void;
Steps out of the function call.
post(
method: 'Debugger.pause',
callback?: (err: null | Error) => void
): void;
Stops on the next JavaScript statement.
post(
method: 'Debugger.resume',
callback?: (err: null | Error) => void
): void;
Resumes JavaScript execution.
post(
method: 'Debugger.getStackTrace',
params?: GetStackTraceParameterType,
callback?: (err: null | Error, params: GetStackTraceReturnType) => void
): void;
Returns stack trace with given <code>stackTraceId</code>.
post(
method: 'Debugger.getStackTrace',
callback?: (err: null | Error, params: GetStackTraceReturnType) => void
): void;
post(
method: 'Debugger.searchInContent',
params?: SearchInContentParameterType,
callback?: (err: null | Error, params: SearchInContentReturnType) => void
): void;
Searches for given string in script content.
post(
method: 'Debugger.searchInContent',
callback?: (err: null | Error, params: SearchInContentReturnType) => void
): void;
post(
method: 'Debugger.setScriptSource',
params?: SetScriptSourceParameterType,
callback?: (err: null | Error, params: SetScriptSourceReturnType) => void
): void;
Edits JavaScript source live.
post(
method: 'Debugger.setScriptSource',
callback?: (err: null | Error, params: SetScriptSourceReturnType) => void
): void;
post(
method: 'Debugger.restartFrame',
params?: RestartFrameParameterType,
callback?: (err: null | Error, params: RestartFrameReturnType) => void
): void;
Restarts particular call frame from the beginning.
post(
method: 'Debugger.restartFrame',
callback?: (err: null | Error, params: RestartFrameReturnType) => void
): void;
post(
method: 'Debugger.getScriptSource',
params?: GetScriptSourceParameterType,
callback?: (err: null | Error, params: GetScriptSourceReturnType) => void
): void;
Returns source for the script with given id.
post(
method: 'Debugger.getScriptSource',
callback?: (err: null | Error, params: GetScriptSourceReturnType) => void
): void;
post(
method: 'Debugger.setPauseOnExceptions',
params?: SetPauseOnExceptionsParameterType,
callback?: (err: null | Error) => 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 <code>none</code>.
post(
method: 'Debugger.setPauseOnExceptions',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.evaluateOnCallFrame',
params?: EvaluateOnCallFrameParameterType,
callback?: (err: null | Error, params: EvaluateOnCallFrameReturnType) => void
): void;
Evaluates expression on a given call frame.
post(
method: 'Debugger.evaluateOnCallFrame',
callback?: (err: null | Error, params: EvaluateOnCallFrameReturnType) => void
): void;
post(
method: 'Debugger.setVariableValue',
params?: SetVariableValueParameterType,
callback?: (err: null | Error) => 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: null | Error) => void
): void;
post(
method: 'Debugger.setReturnValue',
params?: SetReturnValueParameterType,
callback?: (err: null | Error) => void
): void;
Changes return value in top frame. Available only at return break position.
post(
method: 'Debugger.setReturnValue',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.setAsyncCallStackDepth',
params?: SetAsyncCallStackDepthParameterType,
callback?: (err: null | Error) => void
): void;
Enables or disables async call stacks tracking.
post(
method: 'Debugger.setAsyncCallStackDepth',
callback?: (err: null | Error) => void
): void;
post(
method: 'Debugger.setBlackboxPatterns',
params?: SetBlackboxPatternsParameterType,
callback?: (err: null | Error) => 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: null | Error) => void
): void;
post(
method: 'Debugger.setBlackboxedRanges',
params?: SetBlackboxedRangesParameterType,
callback?: (err: null | Error) => 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: null | Error) => void
): void;
post(
method: 'Console.enable',
callback?: (err: null | Error) => void
): void;
Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification.
post(
method: 'Console.disable',
callback?: (err: null | Error) => void
): void;
Disables console domain, prevents further console messages from being reported to the client.
post(
method: 'Console.clearMessages',
callback?: (err: null | Error) => void
): void;
Does nothing.
post(
method: 'Profiler.enable',
callback?: (err: null | Error) => void
): void;
post(
method: 'Profiler.disable',
callback?: (err: null | Error) => void
): void;
post(
method: 'Profiler.setSamplingInterval',
params?: SetSamplingIntervalParameterType,
callback?: (err: null | Error) => void
): void;
Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.
post(
method: 'Profiler.setSamplingInterval',
callback?: (err: null | Error) => void
): void;
post(
method: 'Profiler.start',
callback?: (err: null | Error) => void
): void;
post(
method: 'Profiler.stop',
callback?: (err: null | Error, params: StopReturnType) => void
): void;
post(
method: 'Profiler.startPreciseCoverage',
params?: StartPreciseCoverageParameterType,
callback?: (err: null | Error) => 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: null | Error) => void
): void;
post(
method: 'Profiler.stopPreciseCoverage',
callback?: (err: null | Error) => void
): void;
Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code.
post(
method: 'Profiler.takePreciseCoverage',
callback?: (err: null | Error, params: 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: null | Error, params: 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: null | Error) => void
): void;
post(
method: 'HeapProfiler.disable',
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.startTrackingHeapObjects',
params?: StartTrackingHeapObjectsParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.startTrackingHeapObjects',
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.stopTrackingHeapObjects',
params?: StopTrackingHeapObjectsParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.stopTrackingHeapObjects',
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.takeHeapSnapshot',
params?: TakeHeapSnapshotParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.takeHeapSnapshot',
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.collectGarbage',
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.getObjectByHeapObjectId',
params?: GetObjectByHeapObjectIdParameterType,
callback?: (err: null | Error, params: GetObjectByHeapObjectIdReturnType) => void
): void;
post(
method: 'HeapProfiler.getObjectByHeapObjectId',
callback?: (err: null | Error, params: GetObjectByHeapObjectIdReturnType) => void
): void;
post(
method: 'HeapProfiler.addInspectedHeapObject',
params?: AddInspectedHeapObjectParameterType,
callback?: (err: null | Error) => 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: null | Error) => void
): void;
post(
method: 'HeapProfiler.getHeapObjectId',
params?: GetHeapObjectIdParameterType,
callback?: (err: null | Error, params: GetHeapObjectIdReturnType) => void
): void;
post(
method: 'HeapProfiler.getHeapObjectId',
callback?: (err: null | Error, params: GetHeapObjectIdReturnType) => void
): void;
post(
method: 'HeapProfiler.startSampling',
params?: StartSamplingParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.startSampling',
callback?: (err: null | Error) => void
): void;
post(
method: 'HeapProfiler.stopSampling',
callback?: (err: null | Error, params: StopSamplingReturnType) => void
): void;
post(
method: 'HeapProfiler.getSamplingProfile',
callback?: (err: null | Error, params: GetSamplingProfileReturnType) => void
): void;
post(
method: 'NodeTracing.getCategories',
callback?: (err: null | Error, params: GetCategoriesReturnType) => void
): void;
Gets supported tracing categories.
post(
method: 'NodeTracing.start',
params?: StartParameterType,
callback?: (err: null | Error) => void
): void;
Start trace events collection.
post(
method: 'NodeTracing.start',
callback?: (err: null | Error) => void
): void;
post(
method: 'NodeTracing.stop',
callback?: (err: null | Error) => 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?: SendMessageToWorkerParameterType,
callback?: (err: null | Error) => void
): void;
Sends protocol message over session with given id.
post(
method: 'NodeWorker.sendMessageToWorker',
callback?: (err: null | Error) => void
): void;
post(
method: 'NodeWorker.enable',
params?: EnableParameterType,
callback?: (err: null | Error) => 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: null | Error) => void
): void;
post(
method: 'NodeWorker.disable',
callback?: (err: null | Error) => void
): void;
Detaches from all running workers and disables attaching to new workers as they are started.
post(
method: 'NodeWorker.detach',
params?: DetachParameterType,
callback?: (err: null | Error) => void
): void;
Detached from the worker with given sessionId.
post(
method: 'NodeWorker.detach',
callback?: (err: null | Error) => void
): void;
post(
method: 'Network.disable',
callback?: (err: null | Error) => void
): void;
Disables network tracking, prevents network events from being sent to the client.
post(
method: 'Network.enable',
callback?: (err: null | Error) => void
): void;
Enables network tracking, network events will now be delivered to the client.
post(
method: 'Network.getRequestPostData',
params?: GetRequestPostDataParameterType,
callback?: (err: null | Error, params: GetRequestPostDataReturnType) => void
): void;
Returns post data sent with the request. Returns an error when no data was sent with the request.
post(
method: 'Network.getRequestPostData',
callback?: (err: null | Error, params: GetRequestPostDataReturnType) => void
): void;
post(
method: 'Network.getResponseBody',
params?: GetResponseBodyParameterType,
callback?: (err: null | Error, params: GetResponseBodyReturnType) => void
): void;
Returns content served for the given request.
post(
method: 'Network.getResponseBody',
callback?: (err: null | Error, params: GetResponseBodyReturnType) => void
): void;
post(
method: 'Network.streamResourceContent',
params?: StreamResourceContentParameterType,
callback?: (err: null | Error, params: StreamResourceContentReturnType) => void
): void;
Enables streaming of the response for the given requestId. If enabled, the dataReceived event contains the data that was received during streaming.
post(
method: 'Network.streamResourceContent',
callback?: (err: null | Error, params: StreamResourceContentReturnType) => void
): void;
post(
method: 'Network.loadNetworkResource',
params?: LoadNetworkResourceParameterType,
callback?: (err: null | Error, params: LoadNetworkResourceReturnType) => void
): void;
Fetches the resource and returns the content.
post(
method: 'Network.loadNetworkResource',
callback?: (err: null | Error, params: LoadNetworkResourceReturnType) => void
): void;
post(
method: 'NodeRuntime.enable',
callback?: (err: null | Error) => void
): void;
Enable the NodeRuntime events except by NodeRuntime.waitingForDisconnect.
post(
method: 'NodeRuntime.disable',
callback?: (err: null | Error) => void
): void;
Disable NodeRuntime events
post(
method: 'NodeRuntime.notifyWhenWaitingForDisconnect',
params?: NotifyWhenWaitingForDisconnectParameterType,
callback?: (err: null | Error) => void
): void;
Enable the NodeRuntime.waitingForDisconnect.
post(
method: 'NodeRuntime.notifyWhenWaitingForDisconnect',
callback?: (err: null | Error) => void
): void;
post(
method: 'Target.setAutoAttach',
params?: SetAutoAttachParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'Target.setAutoAttach',
callback?: (err: null | Error) => void
): void;
post(
method: 'IO.read',
params?: ReadParameterType,
callback?: (err: null | Error, params: ReadReturnType) => void
): void;
Read a chunk of the stream
post(
method: 'IO.read',
callback?: (err: null | Error, params: ReadReturnType) => void
): void;
post(
method: 'IO.close',
params?: CloseParameterType,
callback?: (err: null | Error) => void
): void;
post(
method: 'IO.close',
callback?: (err: null | Error) => void
): void;
prependListener(
event: string,
listener: (...args: any[]) => void
): this;
Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
server.prependListener('connection', (stream) => { console.log('someone connected!'); });
Returns a reference to the EventEmitter, so that calls can be chained.
@param event
The name of the event.
@param listener
The callback function
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<ExecutionContextCreatedEventDataType>) => void
): this;
Issued when new execution context is created.
prependListener(
event: 'Runtime.executionContextDestroyed',
listener: (message: InspectorNotification<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<ExceptionThrownEventDataType>) => void
): this;
Issued when exception was thrown and unhandled.
prependListener(
event: 'Runtime.exceptionRevoked',
listener: (message: InspectorNotification<ExceptionRevokedEventDataType>) => void
): this;
Issued when unhandled exception was revoked.
prependListener(
event: 'Runtime.consoleAPICalled',
listener: (message: InspectorNotification<ConsoleAPICalledEventDataType>) => void
): this;
Issued when console API was called.
prependListener(
event: 'Runtime.inspectRequested',
listener: (message: InspectorNotification<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<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<ScriptFailedToParseEventDataType>) => void
): this;
Fired when virtual machine fails to parse the script.
prependListener(
event: 'Debugger.breakpointResolved',
listener: (message: InspectorNotification<BreakpointResolvedEventDataType>) => void
): this;
Fired when breakpoint is resolved to an actual script and location.
prependListener(
event: 'Debugger.paused',
listener: (message: InspectorNotification<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<MessageAddedEventDataType>) => void
): this;
Issued when new console message is added.
prependListener(
event: 'Profiler.consoleProfileStarted',
listener: (message: InspectorNotification<ConsoleProfileStartedEventDataType>) => void
): this;
Sent when new profile recording is started using console.profile() call.
prependListener(
event: 'Profiler.consoleProfileFinished',
listener: (message: InspectorNotification<ConsoleProfileFinishedEventDataType>) => void
): this;
prependListener(
event: 'HeapProfiler.addHeapSnapshotChunk',
listener: (message: InspectorNotification<AddHeapSnapshotChunkEventDataType>) => void
): this;
prependListener(
event: 'HeapProfiler.resetProfiles',
listener: () => void
): this;
prependListener(
event: 'HeapProfiler.reportHeapSnapshotProgress',
listener: (message: InspectorNotification<ReportHeapSnapshotProgressEventDataType>) => void
): this;
prependListener(
event: 'HeapProfiler.lastSeenObjectId',
listener: (message: InspectorNotification<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.
prependListener(
event: 'HeapProfiler.heapStatsUpdate',
listener: (message: InspectorNotification<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<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<AttachedToWorkerEventDataType>) => void
): this;
Issued when attached to a worker.
prependListener(
event: 'NodeWorker.detachedFromWorker',
listener: (message: InspectorNotification<DetachedFromWorkerEventDataType>) => void
): this;
Issued when detached from the worker.
prependListener(
event: 'NodeWorker.receivedMessageFromWorker',
listener: (message: InspectorNotification<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<RequestWillBeSentEventDataType>) => void
): this;
Fired when page is about to send HTTP request.
prependListener(
event: 'Network.responseReceived',
listener: (message: InspectorNotification<ResponseReceivedEventDataType>) => void
): this;
Fired when HTTP response is available.
prependListener(
event: 'Network.loadingFailed',
listener: (message: InspectorNotification<LoadingFailedEventDataType>) => void
): this;
prependListener(
event: 'Network.loadingFinished',
listener: (message: InspectorNotification<LoadingFinishedEventDataType>) => void
): this;
prependListener(
event: 'Network.dataReceived',
listener: (message: InspectorNotification<DataReceivedEventDataType>) => void
): this;
Fired when data chunk was received over the network.
prependListener(
event: 'Network.webSocketCreated',
listener: (message: InspectorNotification<WebSocketCreatedEventDataType>) => void
): this;
Fired upon WebSocket creation.
prependListener(
event: 'Network.webSocketClosed',
listener: (message: InspectorNotification<WebSocketClosedEventDataType>) => void
): this;
Fired when WebSocket is closed.
prependListener(
event: 'Network.webSocketHandshakeResponseReceived',
listener: (message: InspectorNotification<WebSocketHandshakeResponseReceivedEventDataType>) => void
): this;
Fired when WebSocket handshake response becomes available.
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
prependListener(
event: 'Target.targetCreated',
listener: (message: InspectorNotification<TargetCreatedEventDataType>) => void
): this;
prependListener(
event: 'Target.attachedToTarget',
listener: (message: InspectorNotification<AttachedToTargetEventDataType>) => void
): this;
prependOnceListener(
event: string,
listener: (...args: any[]) => void
): this;
Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });
Returns a reference to the EventEmitter, so that calls can be chained.
@param event
The name of the event.
@param listener
The callback function
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<ExecutionContextCreatedEventDataType>) => void
): this;
Issued when new execution context is created.
prependOnceListener(
event: 'Runtime.executionContextDestroyed',
listener: (message: InspectorNotification<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<ExceptionThrownEventDataType>) => void
): this;
Issued when exception was thrown and unhandled.
prependOnceListener(
event: 'Runtime.exceptionRevoked',
listener: (message: InspectorNotification<ExceptionRevokedEventDataType>) => void
): this;
Issued when unhandled exception was revoked.
prependOnceListener(
event: 'Runtime.consoleAPICalled',
listener: (message: InspectorNotification<ConsoleAPICalledEventDataType>) => void
): this;
Issued when console API was called.
prependOnceListener(
event: 'Runtime.inspectRequested',
listener: (message: InspectorNotification<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<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<ScriptFailedToParseEventDataType>) => void
): this;
Fired when virtual machine fails to parse the script.
prependOnceListener(
event: 'Debugger.breakpointResolved',
listener: (message: InspectorNotification<BreakpointResolvedEventDataType>) => void
): this;
Fired when breakpoint is resolved to an actual script and location.
prependOnceListener(
event: 'Debugger.paused',
listener: (message: InspectorNotification<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<MessageAddedEventDataType>) => void
): this;
Issued when new console message is added.
prependOnceListener(
event: 'Profiler.consoleProfileStarted',
listener: (message: InspectorNotification<ConsoleProfileStartedEventDataType>) => void
): this;
Sent when new profile recording is started using console.profile() call.
prependOnceListener(
event: 'Profiler.consoleProfileFinished',
listener: (message: InspectorNotification<ConsoleProfileFinishedEventDataType>) => void
): this;
prependOnceListener(
event: 'HeapProfiler.addHeapSnapshotChunk',
listener: (message: InspectorNotification<AddHeapSnapshotChunkEventDataType>) => void
): this;
prependOnceListener(
event: 'HeapProfiler.resetProfiles',
listener: () => void
): this;
prependOnceListener(
event: 'HeapProfiler.reportHeapSnapshotProgress',
listener: (message: InspectorNotification<ReportHeapSnapshotProgressEventDataType>) => void
): this;
prependOnceListener(
event: 'HeapProfiler.lastSeenObjectId',
listener: (message: InspectorNotification<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.
prependOnceListener(
event: 'HeapProfiler.heapStatsUpdate',
listener: (message: InspectorNotification<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<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<AttachedToWorkerEventDataType>) => void
): this;
Issued when attached to a worker.
prependOnceListener(
event: 'NodeWorker.detachedFromWorker',
listener: (message: InspectorNotification<DetachedFromWorkerEventDataType>) => void
): this;
Issued when detached from the worker.
prependOnceListener(
event: 'NodeWorker.receivedMessageFromWorker',
listener: (message: InspectorNotification<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<RequestWillBeSentEventDataType>) => void
): this;
Fired when page is about to send HTTP request.
prependOnceListener(
event: 'Network.responseReceived',
listener: (message: InspectorNotification<ResponseReceivedEventDataType>) => void
): this;
Fired when HTTP response is available.
prependOnceListener(
event: 'Network.loadingFailed',
listener: (message: InspectorNotification<LoadingFailedEventDataType>) => void
): this;
prependOnceListener(
event: 'Network.loadingFinished',
listener: (message: InspectorNotification<LoadingFinishedEventDataType>) => void
): this;
prependOnceListener(
event: 'Network.dataReceived',
listener: (message: InspectorNotification<DataReceivedEventDataType>) => void
): this;
Fired when data chunk was received over the network.
prependOnceListener(
event: 'Network.webSocketCreated',
listener: (message: InspectorNotification<WebSocketCreatedEventDataType>) => void
): this;
Fired upon WebSocket creation.
prependOnceListener(
event: 'Network.webSocketClosed',
listener: (message: InspectorNotification<WebSocketClosedEventDataType>) => void
): this;
Fired when WebSocket is closed.
prependOnceListener(
event: 'Network.webSocketHandshakeResponseReceived',
listener: (message: InspectorNotification<WebSocketHandshakeResponseReceivedEventDataType>) => void
): this;
Fired when WebSocket handshake response becomes available.
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
prependOnceListener(
event: 'Target.targetCreated',
listener: (message: InspectorNotification<TargetCreatedEventDataType>) => void
): this;
prependOnceListener(
event: 'Target.attachedToTarget',
listener: (message: InspectorNotification<AttachedToTargetEventDataType>) => void
): this;

rawListeners<E extends string | symbol>(

eventName: string | symbol

): (...args: any[]) => void[];

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

removeAllListeners<E extends string | symbol>(
eventName?: string | symbol
): this;
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
removeListener<E extends string | symbol>(
eventName: string | symbol,
listener: (...args: any[]) => void
): this;
Removes the specified listener from the listener array for the event named eventName.
const callback = (stream) => { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events'; class MyEmitter extends EventEmitter {} const myEmitter = new MyEmitter(); const callbackA = () => { console.log('A'); myEmitter.removeListener('event', callbackB); }; const callbackB = () => { console.log('B'); }; myEmitter.on('event', callbackA); myEmitter.on('event', callbackB); // callbackA removes listener callbackB but it will still be called. // Internal listener array at time of emit [callbackA, callbackB] myEmitter.emit('event'); // Prints: // A // B // callbackB is now removed. // Internal listener array [callbackA] myEmitter.emit('event'); // Prints: // A
Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:
import { EventEmitter } from 'node:events'; const ee = new EventEmitter(); function pong() { console.log('pong'); } ee.on('ping', pong); ee.once('ping', pong); ee.removeListener('ping', pong); ee.emit('ping'); ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
setMaxListeners(
n: number
): this;
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.