method Session.prototype.post
Unstable
Usage in Deno
```typescript import { Session } from "node:node__inspector--promises.d.ts"; ```
Session.prototype.post(method: string,params?: object,): Promise<void>
Posts a message to the inspector back-end.
```js
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](https://chromedevtools.github.io/devtools-protocol/v8/).
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.
Promise<void>
Session.prototype.post(method: "Schema.getDomains"): Promise<Schema.GetDomainsReturnType>
Returns supported domains.
Promise<Schema.GetDomainsReturnType>
Session.prototype.post(method: "Runtime.evaluate",params?: Runtime.EvaluateParameterType,): Promise<Runtime.EvaluateReturnType>
Evaluates expression on global object.
optional
params: Runtime.EvaluateParameterType
Promise<Runtime.EvaluateReturnType>
Session.prototype.post(method: "Runtime.awaitPromise",params?: Runtime.AwaitPromiseParameterType,): Promise<Runtime.AwaitPromiseReturnType>
Add handler to promise with given promise object id.
optional
params: Runtime.AwaitPromiseParameterType
Promise<Runtime.AwaitPromiseReturnType>
Session.prototype.post(method: "Runtime.callFunctionOn",params?: Runtime.CallFunctionOnParameterType,): Promise<Runtime.CallFunctionOnReturnType>
Calls function with given declaration on the given object. Object group of the result is inherited from the target object.
optional
params: Runtime.CallFunctionOnParameterType
Promise<Runtime.CallFunctionOnReturnType>
Session.prototype.post(method: "Runtime.getProperties",params?: Runtime.GetPropertiesParameterType,): Promise<Runtime.GetPropertiesReturnType>
Returns properties of a given object. Object group of the result is inherited from the target object.
optional
params: Runtime.GetPropertiesParameterType
Promise<Runtime.GetPropertiesReturnType>
Session.prototype.post(method: "Runtime.releaseObject",params?: Runtime.ReleaseObjectParameterType,): Promise<void>
Releases remote object with given id.
optional
params: Runtime.ReleaseObjectParameterType
Promise<void>
Session.prototype.post(method: "Runtime.releaseObjectGroup",params?: Runtime.ReleaseObjectGroupParameterType,): Promise<void>
Releases all remote objects that belong to a given group.
optional
params: Runtime.ReleaseObjectGroupParameterType
Promise<void>
Session.prototype.post(method: "Runtime.setCustomObjectFormatterEnabled",): Promise<void>
optional
params: Runtime.SetCustomObjectFormatterEnabledParameterType
Promise<void>
Session.prototype.post(method: "Runtime.compileScript",params?: Runtime.CompileScriptParameterType,): Promise<Runtime.CompileScriptReturnType>
Compiles expression.
optional
params: Runtime.CompileScriptParameterType
Promise<Runtime.CompileScriptReturnType>
Session.prototype.post(method: "Runtime.runScript",params?: Runtime.RunScriptParameterType,): Promise<Runtime.RunScriptReturnType>
Runs script with given id in a given context.
optional
params: Runtime.RunScriptParameterType
Promise<Runtime.RunScriptReturnType>
Session.prototype.post(method: "Runtime.queryObjects",params?: Runtime.QueryObjectsParameterType,): Promise<Runtime.QueryObjectsReturnType>
optional
params: Runtime.QueryObjectsParameterType
Promise<Runtime.QueryObjectsReturnType>
Session.prototype.post(method: "Runtime.globalLexicalScopeNames",): Promise<Runtime.GlobalLexicalScopeNamesReturnType>
Returns all let, const and class variables from global scope.
optional
params: Runtime.GlobalLexicalScopeNamesParameterType
Session.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.
Promise<Debugger.EnableReturnType>
Session.prototype.post(method: "Debugger.setBreakpointsActive",): Promise<void>
Activates / deactivates all breakpoints on the page.
optional
params: Debugger.SetBreakpointsActiveParameterType
Promise<void>
Session.prototype.post(method: "Debugger.setSkipAllPauses",params?: Debugger.SetSkipAllPausesParameterType,): Promise<void>
Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc).
optional
params: Debugger.SetSkipAllPausesParameterType
Promise<void>
Session.prototype.post(method: "Debugger.setBreakpointByUrl",params?: Debugger.SetBreakpointByUrlParameterType,): 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.optional
params: Debugger.SetBreakpointByUrlParameterType
Session.prototype.post(method: "Debugger.setBreakpoint",params?: Debugger.SetBreakpointParameterType,): Promise<Debugger.SetBreakpointReturnType>
Sets JavaScript breakpoint at a given location.
optional
params: Debugger.SetBreakpointParameterType
Promise<Debugger.SetBreakpointReturnType>
Session.prototype.post(method: "Debugger.removeBreakpoint",params?: Debugger.RemoveBreakpointParameterType,): Promise<void>
Removes JavaScript breakpoint.
optional
params: Debugger.RemoveBreakpointParameterType
Promise<void>
Session.prototype.post(method: "Debugger.getPossibleBreakpoints",): Promise<Debugger.GetPossibleBreakpointsReturnType>
Returns possible locations for breakpoint. scriptId in start and end range locations should be the same.
optional
params: Debugger.GetPossibleBreakpointsParameterType
Session.prototype.post(method: "Debugger.continueToLocation",params?: Debugger.ContinueToLocationParameterType,): Promise<void>
Continues execution until specific location is reached.
optional
params: Debugger.ContinueToLocationParameterType
Promise<void>
Session.prototype.post(method: "Debugger.pauseOnAsyncCall",params?: Debugger.PauseOnAsyncCallParameterType,): Promise<void>
optional
params: Debugger.PauseOnAsyncCallParameterType
Promise<void>
Session.prototype.post(method: "Debugger.stepInto",params?: Debugger.StepIntoParameterType,): Promise<void>
Steps into the function call.
optional
params: Debugger.StepIntoParameterType
Promise<void>
Session.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.
Promise<void>
Session.prototype.post(method: "Debugger.getStackTrace",params?: Debugger.GetStackTraceParameterType,): Promise<Debugger.GetStackTraceReturnType>
Returns stack trace with given
stackTraceId.optional
params: Debugger.GetStackTraceParameterType
Promise<Debugger.GetStackTraceReturnType>
Session.prototype.post(method: "Debugger.searchInContent",params?: Debugger.SearchInContentParameterType,): Promise<Debugger.SearchInContentReturnType>
Searches for given string in script content.
optional
params: Debugger.SearchInContentParameterType
Promise<Debugger.SearchInContentReturnType>
Session.prototype.post(method: "Debugger.setScriptSource",params?: Debugger.SetScriptSourceParameterType,): Promise<Debugger.SetScriptSourceReturnType>
Edits JavaScript source live.
optional
params: Debugger.SetScriptSourceParameterType
Promise<Debugger.SetScriptSourceReturnType>
Session.prototype.post(method: "Debugger.restartFrame",params?: Debugger.RestartFrameParameterType,): Promise<Debugger.RestartFrameReturnType>
Restarts particular call frame from the beginning.
optional
params: Debugger.RestartFrameParameterType
Promise<Debugger.RestartFrameReturnType>
Session.prototype.post(method: "Debugger.getScriptSource",params?: Debugger.GetScriptSourceParameterType,): Promise<Debugger.GetScriptSourceReturnType>
Returns source for the script with given id.
optional
params: Debugger.GetScriptSourceParameterType
Promise<Debugger.GetScriptSourceReturnType>
Session.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.optional
params: Debugger.SetPauseOnExceptionsParameterType
Promise<void>
Session.prototype.post(method: "Debugger.evaluateOnCallFrame",): Promise<Debugger.EvaluateOnCallFrameReturnType>
Evaluates expression on a given call frame.
optional
params: Debugger.EvaluateOnCallFrameParameterType
Session.prototype.post(method: "Debugger.setVariableValue",params?: Debugger.SetVariableValueParameterType,): Promise<void>
Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually.
optional
params: Debugger.SetVariableValueParameterType
Promise<void>
Session.prototype.post(method: "Debugger.setReturnValue",params?: Debugger.SetReturnValueParameterType,): Promise<void>
Changes return value in top frame. Available only at return break position.
optional
params: Debugger.SetReturnValueParameterType
Promise<void>
Session.prototype.post(method: "Debugger.setAsyncCallStackDepth",): Promise<void>
Enables or disables async call stacks tracking.
optional
params: Debugger.SetAsyncCallStackDepthParameterType
Promise<void>
Session.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.
optional
params: Debugger.SetBlackboxPatternsParameterType
Promise<void>
Session.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.
optional
params: Debugger.SetBlackboxedRangesParameterType
Promise<void>
Session.prototype.post(method: "Profiler.setSamplingInterval",): Promise<void>
Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.
optional
params: Profiler.SetSamplingIntervalParameterType
Promise<void>
Session.prototype.post(method: "Profiler.stop"): Promise<Profiler.StopReturnType>
Promise<Profiler.StopReturnType>
Session.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.
optional
params: Profiler.StartPreciseCoverageParameterType
Promise<void>
Session.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.
Session.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.
Session.prototype.post(method: "HeapProfiler.startTrackingHeapObjects",): Promise<void>
optional
params: HeapProfiler.StartTrackingHeapObjectsParameterType
Promise<void>
Session.prototype.post(method: "HeapProfiler.stopTrackingHeapObjects",): Promise<void>
optional
params: HeapProfiler.StopTrackingHeapObjectsParameterType
Promise<void>
Session.prototype.post(method: "HeapProfiler.takeHeapSnapshot",): Promise<void>
optional
params: HeapProfiler.TakeHeapSnapshotParameterType
Promise<void>
Session.prototype.post(method: "HeapProfiler.getObjectByHeapObjectId",): Promise<HeapProfiler.GetObjectByHeapObjectIdReturnType>
optional
params: HeapProfiler.GetObjectByHeapObjectIdParameterType
Session.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).
optional
params: HeapProfiler.AddInspectedHeapObjectParameterType
Promise<void>
Session.prototype.post(method: "HeapProfiler.getHeapObjectId",): Promise<HeapProfiler.GetHeapObjectIdReturnType>
optional
params: HeapProfiler.GetHeapObjectIdParameterType
Session.prototype.post(method: "HeapProfiler.startSampling",params?: HeapProfiler.StartSamplingParameterType,): Promise<void>
optional
params: HeapProfiler.StartSamplingParameterType
Promise<void>
Session.prototype.post(method: "HeapProfiler.stopSampling"): Promise<HeapProfiler.StopSamplingReturnType>
Promise<HeapProfiler.StopSamplingReturnType>
Session.prototype.post(method: "HeapProfiler.getSamplingProfile"): Promise<HeapProfiler.GetSamplingProfileReturnType>
Session.prototype.post(method: "NodeTracing.getCategories"): Promise<NodeTracing.GetCategoriesReturnType>
Gets supported tracing categories.
Promise<NodeTracing.GetCategoriesReturnType>
Session.prototype.post(method: "NodeTracing.start",params?: NodeTracing.StartParameterType,): Promise<void>
Start trace events collection.
optional
params: NodeTracing.StartParameterType
Promise<void>
Session.prototype.post(method: "NodeWorker.sendMessageToWorker",): Promise<void>
Sends protocol message over session with given id.
optional
params: NodeWorker.SendMessageToWorkerParameterType
Promise<void>
Session.prototype.post(method: "NodeWorker.enable",params?: NodeWorker.EnableParameterType,): Promise<void>
Instructs the inspector to attach to running workers. Will also attach to new workers
as they start
optional
params: NodeWorker.EnableParameterType
Promise<void>
Session.prototype.post(method: "NodeWorker.detach",params?: NodeWorker.DetachParameterType,): Promise<void>
Detached from the worker with given sessionId.
optional
params: NodeWorker.DetachParameterType
Promise<void>
Session.prototype.post(method: "NodeRuntime.notifyWhenWaitingForDisconnect",): Promise<void>
Enable the `NodeRuntime.waitingForDisconnect`.
optional
params: NodeRuntime.NotifyWhenWaitingForDisconnectParameterType
Promise<void>