post

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

Posts a message to the inspector back-end.

import { Session } from 'node:inspector/promises';
try {
  const session = new Session();
  session.connect();
  const result = await session.post('Runtime.evaluate', { expression: '2 + 2' });
  console.log(result);
} catch (error) {
  console.error(error);
}
// Output: { result: { type: 'number', value: 4, description: '4' } }

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

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

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

Returns supported domains.

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

Evaluates expression on global object.

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

Add handler to promise with given promise object id.

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

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_GETPROPERTIES, params: GetPropertiesParameterType = definedExternally): Promise<GetPropertiesReturnType>(source)

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

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

Releases remote object with given id.

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

Releases all remote objects that belong to a given group.

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

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

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

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_DISABLE): Promise<Void>(source)

Disables reporting of execution contexts creation.

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

Discards collected exceptions and console API calls.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Compiles expression.

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

Runs script with given id in a given context.

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

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

fun post(method: SessionMethod.DEBUGGER_ENABLE): Promise<EnableReturnType>(source)

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_DISABLE): Promise<Void>(source)

Disables debugger for given page.

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

Activates / deactivates all breakpoints on the page.

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

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

fun post(method: SessionMethod.DEBUGGER_SETBREAKPOINTBYURL, params: SetBreakpointByUrlParameterType = definedExternally): Promise<SetBreakpointByUrlReturnType>(source)

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_SETBREAKPOINT, params: SetBreakpointParameterType = definedExternally): Promise<SetBreakpointReturnType>(source)

Sets JavaScript breakpoint at a given location.

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

Removes JavaScript breakpoint.

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

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

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

Continues execution until specific location is reached.

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

Steps over the statement.

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

Steps into the function call.

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

Steps out of the function call.

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

Stops on the next JavaScript statement.

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

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_RESUME): Promise<Void>(source)

Resumes JavaScript execution.

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

Returns stack trace with given stackTraceId.

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

Searches for given string in script content.

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

Edits JavaScript source live.

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

Restarts particular call frame from the beginning.

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

Returns source for the script with given id.

fun post(method: SessionMethod.DEBUGGER_SETPAUSEONEXCEPTIONS, params: SetPauseOnExceptionsParameterType = definedExternally): Promise<Void>(source)

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_EVALUATEONCALLFRAME, params: EvaluateOnCallFrameParameterType = definedExternally): Promise<EvaluateOnCallFrameReturnType>(source)

Evaluates expression on a given call frame.

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

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

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

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

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

Enables or disables async call stacks tracking.

fun post(method: SessionMethod.DEBUGGER_SETBLACKBOXPATTERNS, params: SetBlackboxPatternsParameterType = definedExternally): Promise<Void>(source)

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_SETBLACKBOXEDRANGES, params: SetBlackboxedRangesParameterType = definedExternally): Promise<Void>(source)

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.CONSOLE_ENABLE): Promise<Void>(source)

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

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

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

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

Does nothing.

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

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

fun post(method: SessionMethod.PROFILER_STARTPRECISECOVERAGE, params: StartPreciseCoverageParameterType = definedExternally): Promise<Void>(source)

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.PROFILER_STOPPRECISECOVERAGE): Promise<Void>(source)

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

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

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

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

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

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

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.NODETRACING_GETCATEGORIES): Promise<GetCategoriesReturnType>(source)

Gets supported tracing categories.

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

Start trace events collection.

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

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_SENDMESSAGETOWORKER, params: SendMessageToWorkerParameterType = definedExternally): Promise<Void>(source)

Sends protocol message over session with given id.

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

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

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

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

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

Detached from the worker with given sessionId.

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

Enable the NodeRuntime events except by NodeRuntime.waitingForDisconnect.

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

Disable NodeRuntime events

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

Enable the NodeRuntime.waitingForDisconnect.