Skip to main content

post

method Session.prototype.post
unstable
Jump to headingSession.prototype.post(
method: string,
params?: object,
): Promise<void>

Posts a message to the inspector back-end.

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

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

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

Parameters Jump to heading

Jump to headingmethod: string
optional
Jump to headingparams: object

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Schema.getDomains"): Promise<Schema.GetDomainsReturnType>

Returns supported domains.

Parameters Jump to heading

Jump to headingmethod: "Schema.getDomains"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.evaluate",
): Promise<Runtime.EvaluateReturnType>

Evaluates expression on global object.

Parameters Jump to heading

Jump to headingmethod: "Runtime.evaluate"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.awaitPromise",
): Promise<Runtime.AwaitPromiseReturnType>

Add handler to promise with given promise object id.

Parameters Jump to heading

Jump to headingmethod: "Runtime.awaitPromise"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.callFunctionOn",
): Promise<Runtime.CallFunctionOnReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Runtime.callFunctionOn"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.getProperties",
): Promise<Runtime.GetPropertiesReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Runtime.getProperties"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.releaseObject",
): Promise<void>

Releases remote object with given id.

Parameters Jump to heading

Jump to headingmethod: "Runtime.releaseObject"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Runtime.releaseObjectGroup",
): Promise<void>

Releases all remote objects that belong to a given group.

Parameters Jump to heading

Jump to headingmethod: "Runtime.releaseObjectGroup"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Runtime.runIfWaitingForDebugger"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Runtime.runIfWaitingForDebugger"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Runtime.enable"): Promise<void>

Enables reporting of execution contexts creation by means of executionContextCreated event. When the reporting gets enabled the event will be sent immediately for each existing execution context.

Parameters Jump to heading

Jump to headingmethod: "Runtime.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Runtime.disable"): Promise<void>

Disables reporting of execution contexts creation.

Parameters Jump to heading

Jump to headingmethod: "Runtime.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Runtime.discardConsoleEntries"): Promise<void>

Discards collected exceptions and console API calls.

Parameters Jump to heading

Jump to headingmethod: "Runtime.discardConsoleEntries"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Runtime.setCustomObjectFormatterEnabled",
): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "Runtime.setCustomObjectFormatterEnabled"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Runtime.compileScript",
): Promise<Runtime.CompileScriptReturnType>

Compiles expression.

Parameters Jump to heading

Jump to headingmethod: "Runtime.compileScript"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.runScript",
): Promise<Runtime.RunScriptReturnType>

Runs script with given id in a given context.

Parameters Jump to heading

Jump to headingmethod: "Runtime.runScript"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.queryObjects",
): Promise<Runtime.QueryObjectsReturnType>

Parameters Jump to heading

Jump to headingmethod: "Runtime.queryObjects"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Runtime.globalLexicalScopeNames",
): Promise<Runtime.GlobalLexicalScopeNamesReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Runtime.globalLexicalScopeNames"

Return Type Jump to heading

Jump to headingSession.prototype.post(method: "Debugger.enable"): Promise<Debugger.EnableReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Debugger.enable"

Return Type Jump to heading

Jump to headingSession.prototype.post(method: "Debugger.disable"): Promise<void>

Disables debugger for given page.

Parameters Jump to heading

Jump to headingmethod: "Debugger.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setBreakpointsActive",
): Promise<void>

Activates / deactivates all breakpoints on the page.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setBreakpointsActive"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setSkipAllPauses",
): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Debugger.setSkipAllPauses"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setBreakpointByUrl",
): Promise<Debugger.SetBreakpointByUrlReturnType>

Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setBreakpointByUrl"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.setBreakpoint",
): Promise<Debugger.SetBreakpointReturnType>

Sets JavaScript breakpoint at a given location.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setBreakpoint"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.removeBreakpoint",
): Promise<void>

Removes JavaScript breakpoint.

Parameters Jump to heading

Jump to headingmethod: "Debugger.removeBreakpoint"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.getPossibleBreakpoints",
): Promise<Debugger.GetPossibleBreakpointsReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Debugger.getPossibleBreakpoints"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.continueToLocation",
): Promise<void>

Continues execution until specific location is reached.

Parameters Jump to heading

Jump to headingmethod: "Debugger.continueToLocation"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.pauseOnAsyncCall",
): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "Debugger.pauseOnAsyncCall"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Debugger.stepOver"): Promise<void>

Steps over the statement.

Parameters Jump to heading

Jump to headingmethod: "Debugger.stepOver"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.stepInto",
): Promise<void>

Steps into the function call.

Parameters Jump to heading

Jump to headingmethod: "Debugger.stepInto"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Debugger.stepOut"): Promise<void>

Steps out of the function call.

Parameters Jump to heading

Jump to headingmethod: "Debugger.stepOut"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Debugger.pause"): Promise<void>

Stops on the next JavaScript statement.

Parameters Jump to heading

Jump to headingmethod: "Debugger.pause"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Debugger.scheduleStepIntoAsync"): Promise<void>

This method is deprecated - use Debugger.stepInto with breakOnAsyncCall and Debugger.pauseOnAsyncTask instead. Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called.

Parameters Jump to heading

Jump to headingmethod: "Debugger.scheduleStepIntoAsync"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Debugger.resume"): Promise<void>

Resumes JavaScript execution.

Parameters Jump to heading

Jump to headingmethod: "Debugger.resume"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.getStackTrace",
): Promise<Debugger.GetStackTraceReturnType>

Returns stack trace with given stackTraceId.

Parameters Jump to heading

Jump to headingmethod: "Debugger.getStackTrace"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.searchInContent",
): Promise<Debugger.SearchInContentReturnType>

Searches for given string in script content.

Parameters Jump to heading

Jump to headingmethod: "Debugger.searchInContent"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.setScriptSource",
): Promise<Debugger.SetScriptSourceReturnType>

Edits JavaScript source live.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setScriptSource"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.restartFrame",
): Promise<Debugger.RestartFrameReturnType>

Restarts particular call frame from the beginning.

Parameters Jump to heading

Jump to headingmethod: "Debugger.restartFrame"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.getScriptSource",
): Promise<Debugger.GetScriptSourceReturnType>

Returns source for the script with given id.

Parameters Jump to heading

Jump to headingmethod: "Debugger.getScriptSource"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.setPauseOnExceptions",
): 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.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setPauseOnExceptions"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.evaluateOnCallFrame",
): Promise<Debugger.EvaluateOnCallFrameReturnType>

Evaluates expression on a given call frame.

Parameters Jump to heading

Jump to headingmethod: "Debugger.evaluateOnCallFrame"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Debugger.setVariableValue",
): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Debugger.setVariableValue"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setReturnValue",
): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Debugger.setReturnValue"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setAsyncCallStackDepth",
): Promise<void>

Enables or disables async call stacks tracking.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setAsyncCallStackDepth"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setBlackboxPatterns",
): 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.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setBlackboxPatterns"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Debugger.setBlackboxedRanges",
): 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.

Parameters Jump to heading

Jump to headingmethod: "Debugger.setBlackboxedRanges"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Console.enable"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Console.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Console.disable"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Console.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Console.clearMessages"): Promise<void>

Does nothing.

Parameters Jump to heading

Jump to headingmethod: "Console.clearMessages"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Profiler.enable"): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "Profiler.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Profiler.disable"): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "Profiler.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "Profiler.setSamplingInterval",
): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Profiler.setSamplingInterval"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Profiler.start"): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "Profiler.start"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Profiler.stop"): Promise<Profiler.StopReturnType>

Parameters Jump to heading

Jump to headingmethod: "Profiler.stop"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "Profiler.startPreciseCoverage",
): 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.

Parameters Jump to heading

Jump to headingmethod: "Profiler.startPreciseCoverage"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Profiler.stopPreciseCoverage"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Profiler.stopPreciseCoverage"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Profiler.takePreciseCoverage"): Promise<Profiler.TakePreciseCoverageReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Profiler.takePreciseCoverage"

Return Type Jump to heading

Jump to headingSession.prototype.post(method: "Profiler.getBestEffortCoverage"): Promise<Profiler.GetBestEffortCoverageReturnType>

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

Parameters Jump to heading

Jump to headingmethod: "Profiler.getBestEffortCoverage"

Return Type Jump to heading

Jump to headingSession.prototype.post(method: "HeapProfiler.enable"): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "HeapProfiler.disable"): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "HeapProfiler.startTrackingHeapObjects",
): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.startTrackingHeapObjects"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "HeapProfiler.stopTrackingHeapObjects",
): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.stopTrackingHeapObjects"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "HeapProfiler.takeHeapSnapshot",
): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.takeHeapSnapshot"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "HeapProfiler.collectGarbage"): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.collectGarbage"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "HeapProfiler.getObjectByHeapObjectId",
): Promise<HeapProfiler.GetObjectByHeapObjectIdReturnType>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.getObjectByHeapObjectId"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "HeapProfiler.addInspectedHeapObject",
): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.addInspectedHeapObject"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "HeapProfiler.getHeapObjectId",
): Promise<HeapProfiler.GetHeapObjectIdReturnType>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.getHeapObjectId"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "HeapProfiler.startSampling",
): Promise<void>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.startSampling"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "HeapProfiler.stopSampling"): Promise<HeapProfiler.StopSamplingReturnType>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.stopSampling"

Return Type Jump to heading

Jump to headingSession.prototype.post(method: "HeapProfiler.getSamplingProfile"): Promise<HeapProfiler.GetSamplingProfileReturnType>

Parameters Jump to heading

Jump to headingmethod: "HeapProfiler.getSamplingProfile"

Return Type Jump to heading

Jump to headingSession.prototype.post(method: "NodeTracing.getCategories"): Promise<NodeTracing.GetCategoriesReturnType>

Gets supported tracing categories.

Parameters Jump to heading

Jump to headingmethod: "NodeTracing.getCategories"

Return Type Jump to heading

Jump to headingSession.prototype.post(
method: "NodeTracing.start",
): Promise<void>

Start trace events collection.

Parameters Jump to heading

Jump to headingmethod: "NodeTracing.start"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "NodeTracing.stop"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "NodeTracing.stop"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "NodeWorker.sendMessageToWorker",
): Promise<void>

Sends protocol message over session with given id.

Parameters Jump to heading

Jump to headingmethod: "NodeWorker.sendMessageToWorker"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "NodeWorker.enable",
): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "NodeWorker.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "NodeWorker.disable"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "NodeWorker.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "NodeWorker.detach",
): Promise<void>

Detached from the worker with given sessionId.

Parameters Jump to heading

Jump to headingmethod: "NodeWorker.detach"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Network.disable"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Network.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "Network.enable"): Promise<void>

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

Parameters Jump to heading

Jump to headingmethod: "Network.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "NodeRuntime.enable"): Promise<void>

Enable the NodeRuntime events except by NodeRuntime.waitingForDisconnect.

Parameters Jump to heading

Jump to headingmethod: "NodeRuntime.enable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(method: "NodeRuntime.disable"): Promise<void>

Disable NodeRuntime events

Parameters Jump to heading

Jump to headingmethod: "NodeRuntime.disable"

Return Type Jump to heading

Promise<void>
Jump to headingSession.prototype.post(
method: "NodeRuntime.notifyWhenWaitingForDisconnect",
): Promise<void>

Enable the NodeRuntime.waitingForDisconnect.

Parameters Jump to heading

Jump to headingmethod: "NodeRuntime.notifyWhenWaitingForDisconnect"

Return Type Jump to heading

Promise<void>
Back to top