Session

external class Session : EventEmitter(source)

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

Since

v19.0.0

Constructors

Session

constructor()

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.

Properties

ConsoleMessageAddedEvent

val ConsoleMessageAddedEvent: EventInstance<JsTuple1<InspectorNotification<MessageAddedEventDataType>>>

DebuggerBreakpointResolvedEvent

val DebuggerBreakpointResolvedEvent: EventInstance<JsTuple1<InspectorNotification<BreakpointResolvedEventDataType>>>

DebuggerPausedEvent

val DebuggerPausedEvent: EventInstance<JsTuple1<InspectorNotification<PausedEventDataType>>>

DebuggerResumedEvent

val DebuggerResumedEvent: EventInstance<JsTuple>

DebuggerScriptFailedToParseEvent

val DebuggerScriptFailedToParseEvent: EventInstance<JsTuple1<InspectorNotification<ScriptFailedToParseEventDataType>>>

DebuggerScriptParsedEvent

val DebuggerScriptParsedEvent: EventInstance<JsTuple1<InspectorNotification<ScriptParsedEventDataType>>>

HeapProfilerAddHeapSnapshotChunkEvent

val HeapProfilerAddHeapSnapshotChunkEvent: EventInstance<JsTuple1<InspectorNotification<AddHeapSnapshotChunkEventDataType>>>

HeapProfilerHeapStatsUpdateEvent

val HeapProfilerHeapStatsUpdateEvent: EventInstance<JsTuple1<InspectorNotification<HeapStatsUpdateEventDataType>>>

HeapProfilerLastSeenObjectIdEvent

val HeapProfilerLastSeenObjectIdEvent: EventInstance<JsTuple1<InspectorNotification<LastSeenObjectIdEventDataType>>>

HeapProfilerReportHeapSnapshotProgressEvent

val HeapProfilerReportHeapSnapshotProgressEvent: EventInstance<JsTuple1<InspectorNotification<ReportHeapSnapshotProgressEventDataType>>>

HeapProfilerResetProfilesEvent

val HeapProfilerResetProfilesEvent: EventInstance<JsTuple>

inspectorNotificationEvent

val inspectorNotificationEvent: EventInstance<JsTuple1<InspectorNotification<Any>>>

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

NodeRuntimeWaitingForDebuggerEvent

val NodeRuntimeWaitingForDebuggerEvent: EventInstance<JsTuple>

NodeRuntimeWaitingForDisconnectEvent

val NodeRuntimeWaitingForDisconnectEvent: EventInstance<JsTuple>

NodeTracingDataCollectedEvent

val NodeTracingDataCollectedEvent: EventInstance<JsTuple1<InspectorNotification<DataCollectedEventDataType>>>

NodeTracingTracingCompleteEvent

val NodeTracingTracingCompleteEvent: EventInstance<JsTuple>

NodeWorkerAttachedToWorkerEvent

val NodeWorkerAttachedToWorkerEvent: EventInstance<JsTuple1<InspectorNotification<AttachedToWorkerEventDataType>>>

NodeWorkerDetachedFromWorkerEvent

val NodeWorkerDetachedFromWorkerEvent: EventInstance<JsTuple1<InspectorNotification<DetachedFromWorkerEventDataType>>>

NodeWorkerReceivedMessageFromWorkerEvent

val NodeWorkerReceivedMessageFromWorkerEvent: EventInstance<JsTuple1<InspectorNotification<ReceivedMessageFromWorkerEventDataType>>>

ProfilerConsoleProfileFinishedEvent

val ProfilerConsoleProfileFinishedEvent: EventInstance<JsTuple1<InspectorNotification<ConsoleProfileFinishedEventDataType>>>

ProfilerConsoleProfileStartedEvent

val ProfilerConsoleProfileStartedEvent: EventInstance<JsTuple1<InspectorNotification<ConsoleProfileStartedEventDataType>>>

RuntimeConsoleAPICalledEvent

val RuntimeConsoleAPICalledEvent: EventInstance<JsTuple1<InspectorNotification<ConsoleAPICalledEventDataType>>>

RuntimeExceptionRevokedEvent

val RuntimeExceptionRevokedEvent: EventInstance<JsTuple1<InspectorNotification<ExceptionRevokedEventDataType>>>

RuntimeExceptionThrownEvent

val RuntimeExceptionThrownEvent: EventInstance<JsTuple1<InspectorNotification<ExceptionThrownEventDataType>>>

RuntimeExecutionContextCreatedEvent

val RuntimeExecutionContextCreatedEvent: EventInstance<JsTuple1<InspectorNotification<ExecutionContextCreatedEventDataType>>>

RuntimeExecutionContextDestroyedEvent

val RuntimeExecutionContextDestroyedEvent: EventInstance<JsTuple1<InspectorNotification<ExecutionContextDestroyedEventDataType>>>

RuntimeExecutionContextsClearedEvent

val RuntimeExecutionContextsClearedEvent: EventInstance<JsTuple>

RuntimeInspectRequestedEvent

val RuntimeInspectRequestedEvent: EventInstance<JsTuple1<InspectorNotification<InspectRequestedEventDataType>>>

Functions

addListener

fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

fun addListener(event: String, listener: Function<Unit>)

connect

fun connect()

Connects a session to the inspector back-end.

connectToMainThread

fun connectToMainThread()

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

disconnect

fun disconnect()

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

fun emit(type: EventType, vararg 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.

fun emit(event: Symbol, vararg args: Any?): Boolean

fun emit(event: String, vararg args: Any?): Boolean

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

eventNames

fun eventNames(): Array<EventType>

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

getMaxListeners

fun getMaxListeners(): Double

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

listenerCount

fun listenerCount(type: EventType, listener: EventListener = definedExternally): Double

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.

listeners

fun listeners(type: EventType): Array<EventListener>

Returns a copy of the array of listeners for the event named eventName.

off

fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

fun on(type: EventType, listener: EventListener)

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.

fun on(event: String, listener: Function<Unit>)

once

fun once(type: EventType, listener: EventListener)

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

fun once(event: String, listener: Function<Unit>)

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

post

fun post(method: SessionMethod.CONSOLE_CLEARMESSAGES): Promise<Void>

Does nothing.

fun post(method: SessionMethod.CONSOLE_DISABLE): Promise<Void>

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

fun post(method: SessionMethod.CONSOLE_ENABLE): Promise<Void>

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

fun post(method: SessionMethod.DEBUGGER_DISABLE): Promise<Void>

Disables debugger for given page.

fun post(method: SessionMethod.DEBUGGER_ENABLE): Promise<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.

fun post(method: SessionMethod.DEBUGGER_PAUSE): Promise<Void>

Stops on the next JavaScript statement.

fun post(method: SessionMethod.DEBUGGER_RESUME): Promise<Void>

Resumes JavaScript execution.

fun post(method: SessionMethod.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.

fun post(method: SessionMethod.DEBUGGER_STEPOUT): Promise<Void>

Steps out of the function call.

fun post(method: SessionMethod.DEBUGGER_STEPOVER): Promise<Void>

Steps over the statement.

fun post(method: SessionMethod.HEAPPROFILER_COLLECTGARBAGE): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_DISABLE): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_ENABLE): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_GETSAMPLINGPROFILE): Promise<GetSamplingProfileReturnType>

fun post(method: SessionMethod.HEAPPROFILER_STOPSAMPLING): Promise<StopSamplingReturnType>

fun post(method: SessionMethod.PROFILER_DISABLE): Promise<Void>

fun post(method: SessionMethod.PROFILER_ENABLE): Promise<Void>

fun post(method: SessionMethod.PROFILER_START): Promise<Void>

fun post(method: SessionMethod.PROFILER_STOP): Promise<StopReturnType>

fun post(method: SessionMethod.DEBUGGER_PAUSEONASYNCCALL, params: PauseOnAsyncCallParameterType = definedExternally): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_GETHEAPOBJECTID, params: GetHeapObjectIdParameterType = definedExternally): Promise<GetHeapObjectIdReturnType>

fun post(method: SessionMethod.HEAPPROFILER_GETOBJECTBYHEAPOBJECTID, params: GetObjectByHeapObjectIdParameterType = definedExternally): Promise<GetObjectByHeapObjectIdReturnType>

fun post(method: SessionMethod.HEAPPROFILER_STARTSAMPLING, params: StartSamplingParameterType = definedExternally): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_STARTTRACKINGHEAPOBJECTS, params: StartTrackingHeapObjectsParameterType = definedExternally): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_STOPTRACKINGHEAPOBJECTS, params: StopTrackingHeapObjectsParameterType = definedExternally): Promise<Void>

fun post(method: SessionMethod.HEAPPROFILER_TAKEHEAPSNAPSHOT, params: TakeHeapSnapshotParameterType = definedExternally): Promise<Void>

fun post(method: SessionMethod.RUNTIME_QUERYOBJECTS, params: QueryObjectsParameterType = definedExternally): Promise<QueryObjectsReturnType>

fun post(method: SessionMethod.RUNTIME_SETCUSTOMOBJECTFORMATTERENABLED, params: SetCustomObjectFormatterEnabledParameterType = definedExternally): Promise<Void>

fun post(method: SessionMethod.NODERUNTIME_DISABLE): Promise<Void>

Disable NodeRuntime events

fun post(method: SessionMethod.NODERUNTIME_ENABLE): Promise<Void>

Enable the NodeRuntime events except by NodeRuntime.waitingForDisconnect.

fun post(method: SessionMethod.NODETRACING_GETCATEGORIES): Promise<GetCategoriesReturnType>

Gets supported tracing categories.

fun post(method: SessionMethod.NODETRACING_STOP): Promise<Void>

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

fun post(method: SessionMethod.NODEWORKER_DISABLE): Promise<Void>

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

fun post(method: SessionMethod.PROFILER_GETBESTEFFORTCOVERAGE): Promise<GetBestEffortCoverageReturnType>

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

fun post(method: SessionMethod.PROFILER_STOPPRECISECOVERAGE): Promise<Void>

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

fun post(method: SessionMethod.PROFILER_TAKEPRECISECOVERAGE): Promise<TakePreciseCoverageReturnType>

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

fun post(method: SessionMethod.RUNTIME_DISABLE): Promise<Void>

Disables reporting of execution contexts creation.

fun post(method: SessionMethod.RUNTIME_DISCARDCONSOLEENTRIES): Promise<Void>

Discards collected exceptions and console API calls.

fun post(method: SessionMethod.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.

fun post(method: SessionMethod.RUNTIME_RUNIFWAITINGFORDEBUGGER): Promise<Void>

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

fun post(method: SessionMethod.SCHEMA_GETDOMAINS): Promise<GetDomainsReturnType>

Returns supported domains.

fun post(method: String, params: Any = definedExternally): Promise<Void>

Posts a message to the inspector back-end.

fun post(method: SessionMethod.DEBUGGER_CONTINUETOLOCATION, params: ContinueToLocationParameterType = definedExternally): Promise<Void>

Continues execution until specific location is reached.

fun post(method: SessionMethod.DEBUGGER_EVALUATEONCALLFRAME, params: EvaluateOnCallFrameParameterType = definedExternally): Promise<EvaluateOnCallFrameReturnType>

Evaluates expression on a given call frame.

fun post(method: SessionMethod.DEBUGGER_GETPOSSIBLEBREAKPOINTS, params: GetPossibleBreakpointsParameterType = definedExternally): Promise<GetPossibleBreakpointsReturnType>

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

fun post(method: SessionMethod.DEBUGGER_GETSCRIPTSOURCE, params: GetScriptSourceParameterType = definedExternally): Promise<GetScriptSourceReturnType>

Returns source for the script with given id.

fun post(method: SessionMethod.DEBUGGER_GETSTACKTRACE, params: GetStackTraceParameterType = definedExternally): Promise<GetStackTraceReturnType>

Returns stack trace with given stackTraceId.

fun post(method: SessionMethod.DEBUGGER_REMOVEBREAKPOINT, params: RemoveBreakpointParameterType = definedExternally): Promise<Void>

Removes JavaScript breakpoint.

fun post(method: SessionMethod.DEBUGGER_RESTARTFRAME, params: RestartFrameParameterType = definedExternally): Promise<RestartFrameReturnType>

Restarts particular call frame from the beginning.

fun post(method: SessionMethod.DEBUGGER_SEARCHINCONTENT, params: SearchInContentParameterType = definedExternally): Promise<SearchInContentReturnType>

Searches for given string in script content.

fun post(method: SessionMethod.DEBUGGER_SETASYNCCALLSTACKDEPTH, params: SetAsyncCallStackDepthParameterType = definedExternally): Promise<Void>

Enables or disables async call stacks tracking.

fun post(method: SessionMethod.DEBUGGER_SETBLACKBOXEDRANGES, params: SetBlackboxedRangesParameterType = definedExternally): 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.

fun post(method: SessionMethod.DEBUGGER_SETBLACKBOXPATTERNS, params: SetBlackboxPatternsParameterType = definedExternally): 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.

fun post(method: SessionMethod.DEBUGGER_SETBREAKPOINT, params: SetBreakpointParameterType = definedExternally): Promise<SetBreakpointReturnType>

Sets JavaScript breakpoint at a given location.

fun post(method: SessionMethod.DEBUGGER_SETBREAKPOINTBYURL, params: SetBreakpointByUrlParameterType = definedExternally): Promise<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.

fun post(method: SessionMethod.DEBUGGER_SETBREAKPOINTSACTIVE, params: SetBreakpointsActiveParameterType = definedExternally): Promise<Void>

Activates / deactivates all breakpoints on the page.

fun post(method: SessionMethod.DEBUGGER_SETPAUSEONEXCEPTIONS, params: SetPauseOnExceptionsParameterType = definedExternally): 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.

fun post(method: SessionMethod.DEBUGGER_SETRETURNVALUE, params: SetReturnValueParameterType = definedExternally): Promise<Void>

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

fun post(method: SessionMethod.DEBUGGER_SETSCRIPTSOURCE, params: SetScriptSourceParameterType = definedExternally): Promise<SetScriptSourceReturnType>

Edits JavaScript source live.

fun post(method: SessionMethod.DEBUGGER_SETSKIPALLPAUSES, params: SetSkipAllPausesParameterType = definedExternally): Promise<Void>

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

fun post(method: SessionMethod.DEBUGGER_SETVARIABLEVALUE, params: SetVariableValueParameterType = definedExternally): Promise<Void>

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

fun post(method: SessionMethod.DEBUGGER_STEPINTO, params: StepIntoParameterType = definedExternally): Promise<Void>

Steps into the function call.

fun post(method: SessionMethod.HEAPPROFILER_ADDINSPECTEDHEAPOBJECT, params: AddInspectedHeapObjectParameterType = definedExternally): Promise<Void>

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

fun post(method: SessionMethod.NODERUNTIME_NOTIFYWHENWAITINGFORDISCONNECT, params: NotifyWhenWaitingForDisconnectParameterType = definedExternally): Promise<Void>

Enable the NodeRuntime.waitingForDisconnect.

fun post(method: SessionMethod.NODETRACING_START, params: StartParameterType = definedExternally): Promise<Void>

Start trace events collection.

fun post(method: SessionMethod.NODEWORKER_DETACH, params: DetachParameterType = definedExternally): Promise<Void>

Detached from the worker with given sessionId.

fun post(method: SessionMethod.NODEWORKER_ENABLE, params: EnableParameterType = definedExternally): Promise<Void>

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

fun post(method: SessionMethod.NODEWORKER_SENDMESSAGETOWORKER, params: SendMessageToWorkerParameterType = definedExternally): Promise<Void>

Sends protocol message over session with given id.

fun post(method: SessionMethod.PROFILER_SETSAMPLINGINTERVAL, params: SetSamplingIntervalParameterType = definedExternally): Promise<Void>

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

fun post(method: SessionMethod.PROFILER_STARTPRECISECOVERAGE, params: StartPreciseCoverageParameterType = definedExternally): 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.

fun post(method: SessionMethod.RUNTIME_AWAITPROMISE, params: AwaitPromiseParameterType = definedExternally): Promise<AwaitPromiseReturnType>

Add handler to promise with given promise object id.

fun post(method: SessionMethod.RUNTIME_CALLFUNCTIONON, params: CallFunctionOnParameterType = definedExternally): Promise<CallFunctionOnReturnType>

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

fun post(method: SessionMethod.RUNTIME_COMPILESCRIPT, params: CompileScriptParameterType = definedExternally): Promise<CompileScriptReturnType>

Compiles expression.

fun post(method: SessionMethod.RUNTIME_EVALUATE, params: EvaluateParameterType = definedExternally): Promise<EvaluateReturnType>

Evaluates expression on global object.

fun post(method: SessionMethod.RUNTIME_GETPROPERTIES, params: GetPropertiesParameterType = definedExternally): Promise<GetPropertiesReturnType>

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

fun post(method: SessionMethod.RUNTIME_GLOBALLEXICALSCOPENAMES, params: GlobalLexicalScopeNamesParameterType = definedExternally): Promise<GlobalLexicalScopeNamesReturnType>

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

fun post(method: SessionMethod.RUNTIME_RELEASEOBJECT, params: ReleaseObjectParameterType = definedExternally): Promise<Void>

Releases remote object with given id.

fun post(method: SessionMethod.RUNTIME_RELEASEOBJECTGROUP, params: ReleaseObjectGroupParameterType = definedExternally): Promise<Void>

Releases all remote objects that belong to a given group.

fun post(method: SessionMethod.RUNTIME_RUNSCRIPT, params: RunScriptParameterType = definedExternally): Promise<RunScriptReturnType>

Runs script with given id in a given context.

prependListener

fun prependListener(type: EventType, listener: EventListener)

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.

fun prependListener(event: String, listener: Function<Unit>)

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

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

Adds a one-timelistener 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.

fun prependOnceListener(event: String, listener: Function<Unit>)

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

rawListeners

fun rawListeners(type: EventType): Array<EventListener>

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

removeAllListeners

fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

removeListener

fun removeListener(type: EventType, listener: EventListener)

Removes the specified listener from the listener array for the event named eventName.

setMaxListeners

fun setMaxListeners(n: Number)

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.