Index - Node documentation

Usage

import * as mod from "node:inspector";

The node:inspector module provides an API for interacting with the V8 inspector.

It can be accessed using:

import * as inspector from 'node:inspector/promises';

or

import * as inspector from 'node:inspector';

Classes

c
Session

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

Functions

f
close

Deactivate the inspector. Blocks until there are no active connections.

f
open

Activate inspector on host and port. Equivalent tonode --inspect=[[host:]port], but can be done programmatically after node has started.

f
url

Return the URL of the active inspector, or undefined if there is none.

f
waitForDebugger

Blocks until a client (existing or connected later) has sentRuntime.runIfWaitingForDebugger command.

Interfaces

I
Console.ConsoleMessage

Console message.

I
Console.MessageAddedEventDataType
No documentation available
I
Debugger.BreakLocation
No documentation available
I
Debugger.BreakpointResolvedEventDataType
No documentation available
I
Debugger.CallFrame

JavaScript call frame. Array of call frames form the call stack.

I
Debugger.ContinueToLocationParameterType
No documentation available
I
Debugger.EnableReturnType
No documentation available
I
Debugger.EvaluateOnCallFrameParameterType
No documentation available
I
Debugger.EvaluateOnCallFrameReturnType
No documentation available
I
I
Debugger.GetPossibleBreakpointsReturnType
No documentation available
I
Debugger.GetScriptSourceParameterType
No documentation available
I
Debugger.GetScriptSourceReturnType
No documentation available
I
Debugger.GetStackTraceParameterType
No documentation available
I
Debugger.GetStackTraceReturnType
No documentation available
I
Debugger.Location

Location in the source code.

I
Debugger.PausedEventDataType
No documentation available
I
Debugger.PauseOnAsyncCallParameterType
No documentation available
I
Debugger.RemoveBreakpointParameterType
No documentation available
I
Debugger.RestartFrameParameterType
No documentation available
I
Debugger.RestartFrameReturnType
No documentation available
I
Debugger.Scope

Scope description.

I
Debugger.ScriptFailedToParseEventDataType
No documentation available
I
Debugger.ScriptParsedEventDataType
No documentation available
I
Debugger.ScriptPosition

Location in the source code.

I
Debugger.SearchInContentParameterType
No documentation available
I
Debugger.SearchInContentReturnType
No documentation available
I
Debugger.SearchMatch

Search match for resource.

I
I
Debugger.SetBlackboxedRangesParameterType
No documentation available
I
Debugger.SetBlackboxPatternsParameterType
No documentation available
I
Debugger.SetBreakpointByUrlParameterType
No documentation available
I
Debugger.SetBreakpointByUrlReturnType
No documentation available
I
Debugger.SetBreakpointParameterType
No documentation available
I
Debugger.SetBreakpointReturnType
No documentation available
I
Debugger.SetBreakpointsActiveParameterType
No documentation available
I
Debugger.SetPauseOnExceptionsParameterType
No documentation available
I
Debugger.SetReturnValueParameterType
No documentation available
I
Debugger.SetScriptSourceParameterType
No documentation available
I
Debugger.SetScriptSourceReturnType
No documentation available
I
Debugger.SetSkipAllPausesParameterType
No documentation available
I
Debugger.SetVariableValueParameterType
No documentation available
I
Debugger.StepIntoParameterType
No documentation available
I
HeapProfiler.GetHeapObjectIdParameterType
No documentation available
I
HeapProfiler.GetHeapObjectIdReturnType
No documentation available
I
HeapProfiler.GetSamplingProfileReturnType
No documentation available
I
HeapProfiler.HeapStatsUpdateEventDataType
No documentation available
I
HeapProfiler.LastSeenObjectIdEventDataType
No documentation available
I
HeapProfiler.SamplingHeapProfileNode

Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.

I
HeapProfiler.StartSamplingParameterType
No documentation available
I
HeapProfiler.StopSamplingReturnType
No documentation available
I
HeapProfiler.TakeHeapSnapshotParameterType
No documentation available
I
InspectorNotification
No documentation available
I
NodeTracing.DataCollectedEventDataType
No documentation available
I
NodeTracing.GetCategoriesReturnType
No documentation available
I
NodeTracing.StartParameterType
No documentation available
I
NodeTracing.TraceConfig
No documentation available
I
NodeWorker.AttachedToWorkerEventDataType
No documentation available
I
NodeWorker.DetachedFromWorkerEventDataType
No documentation available
I
NodeWorker.DetachParameterType
No documentation available
I
NodeWorker.EnableParameterType
No documentation available
I
NodeWorker.SendMessageToWorkerParameterType
No documentation available
I
NodeWorker.WorkerInfo
No documentation available
I
I
Profiler.ConsoleProfileStartedEventDataType
No documentation available
I
Profiler.CoverageRange

Coverage data for a source range.

I
Profiler.FunctionCoverage

Coverage data for a JavaScript function.

I
Profiler.GetBestEffortCoverageReturnType
No documentation available
I
Profiler.PositionTickInfo

Specifies a number of samples attributed to a certain source position.

I
Profiler.Profile

Profile.

I
Profiler.ProfileNode

Profile node. Holds callsite information, execution statistics and child nodes.

I
Profiler.ScriptCoverage

Coverage data for a JavaScript script.

I
Profiler.ScriptTypeProfile

Type profile data collected during runtime for a JavaScript script.

I
Profiler.SetSamplingIntervalParameterType
No documentation available
I
Profiler.StartPreciseCoverageParameterType
No documentation available
I
Profiler.StopReturnType
No documentation available
I
Profiler.TakePreciseCoverageReturnType
No documentation available
I
Profiler.TakeTypeProfileReturnType
No documentation available
I
Profiler.TypeObject

Describes a type collected during runtime.

I
Profiler.TypeProfileEntry

Source offset and types for a parameter or return value.

I
Runtime.AwaitPromiseParameterType
No documentation available
I
Runtime.AwaitPromiseReturnType
No documentation available
I
Runtime.CallArgument

Represents function call argument. Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified.

I
Runtime.CallFrame

Stack entry for runtime errors and assertions.

I
Runtime.CallFunctionOnParameterType
No documentation available
I
Runtime.CallFunctionOnReturnType
No documentation available
I
Runtime.CompileScriptParameterType
No documentation available
I
Runtime.CompileScriptReturnType
No documentation available
I
Runtime.ConsoleAPICalledEventDataType
No documentation available
I
Runtime.CustomPreview
No documentation available
I
Runtime.EntryPreview
No documentation available
I
Runtime.EvaluateParameterType
No documentation available
I
Runtime.EvaluateReturnType
No documentation available
I
Runtime.ExceptionDetails

Detailed information about exception (or error) that was thrown during script compilation or execution.

I
Runtime.ExceptionRevokedEventDataType
No documentation available
I
Runtime.ExceptionThrownEventDataType
No documentation available
I
I
Runtime.ExecutionContextDescription

Description of an isolated world.

I
Runtime.GetPropertiesParameterType
No documentation available
I
Runtime.GetPropertiesReturnType
No documentation available
I
I
Runtime.GlobalLexicalScopeNamesReturnType
No documentation available
I
Runtime.InspectRequestedEventDataType
No documentation available
I
Runtime.InternalPropertyDescriptor

Object internal property descriptor. This property isn't normally visible in JavaScript code.

I
Runtime.ObjectPreview

Object containing abbreviated remote object value.

I
Runtime.PropertyDescriptor

Object property descriptor.

I
Runtime.PropertyPreview
No documentation available
I
Runtime.QueryObjectsParameterType
No documentation available
I
Runtime.QueryObjectsReturnType
No documentation available
I
Runtime.ReleaseObjectGroupParameterType
No documentation available
I
Runtime.ReleaseObjectParameterType
No documentation available
I
Runtime.RemoteObject

Mirror object referencing original JavaScript object.

I
Runtime.RunScriptParameterType
No documentation available
I
Runtime.RunScriptReturnType
No documentation available
I
Runtime.StackTrace

Call frames for assertions or error messages.

I
Runtime.StackTraceId

If debuggerId is set stack trace comes from another debugger and can be resolved there. This allows to track cross-debugger calls. See Runtime.StackTrace and Debugger.paused for usages.

I
Schema.Domain

Description of the protocol domain.

I
Schema.GetDomainsReturnType
No documentation available

Namespaces

N
Console
No documentation available
N
Debugger
No documentation available
N
HeapProfiler
No documentation available
N
NodeRuntime
No documentation available
N
NodeTracing
No documentation available
N
NodeWorker
No documentation available
N
Profiler
No documentation available
N
Runtime
No documentation available
N
Schema
No documentation available

Type Aliases

T
Debugger.BreakpointId

Breakpoint identifier.

T
Debugger.CallFrameId

Call frame identifier.

T
HeapProfiler.HeapSnapshotObjectId

Heap snapshot object id.

T
NodeWorker.SessionID

Unique identifier of attached debugging session.

T
NodeWorker.WorkerID
No documentation available
T
Runtime.ExecutionContextId

Id of an execution context.

T
Runtime.RemoteObjectId

Unique object identifier.

T
Runtime.ScriptId

Unique script identifier.

T
Runtime.Timestamp

Number of milliseconds since epoch.

T
Runtime.UniqueDebuggerId

Unique identifier of current debugger.

T
Runtime.UnserializableValue

Primitive value which cannot be JSON-stringified.