// tslint:disable-next-line:dt-header

// Type definitions for inspector

// These definitions are auto-generated.

// Please see https://github.com/DefinitelyTyped/DefinitelyTyped/pull/19330

// for more information.

// tslint:disable:max-line-length

/**

* The `inspector` module provides an API for interacting with the V8 inspector.

*

* It can be accessed using:

*

* ```js

* const inspector = require('inspector');

* ```

* @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/inspector.js)

*/

declare module 'inspector' {

import EventEmitter = require('node:events');

interface InspectorNotification<T> {

method: string;

params: T;

}

namespace Schema {

/**

* Description of the protocol domain.

*/

interface Domain {

/**

* Domain name.

*/

name: string;

/**

* Domain version.

*/

version: string;

}

interface GetDomainsReturnType {

/**

* List of supported domains.

*/

domains: Domain[];

}

}

namespace Runtime {

/**

* Unique script identifier.

*/

type ScriptId = string;

/**

* Unique object identifier.

*/

type RemoteObjectId = string;

/**

* Primitive value which cannot be JSON-stringified.

*/

type UnserializableValue = string;

/**

* Mirror object referencing original JavaScript object.

*/

interface RemoteObject {

/**

* Object type.

*/

type: string;

/**

* Object subtype hint. Specified for <code>object</code> type values only.

*/

subtype?: string | undefined;

/**

* Object class (constructor) name. Specified for <code>object</code> type values only.

*/

className?: string | undefined;

/**

* Remote object value in case of primitive values or JSON values (if it was requested).

*/

value?: any;

/**

* Primitive value which can not be JSON-stringified does not have <code>value</code>, but gets this property.

*/

unserializableValue?: UnserializableValue | undefined;

/**

* String representation of the object.

*/

description?: string | undefined;

/**

* Unique object identifier (for non-primitive values).

*/

objectId?: RemoteObjectId | undefined;

/**

* Preview containing abbreviated property values. Specified for <code>object</code> type values only.

* @experimental

*/

preview?: ObjectPreview | undefined;

/**

* @experimental

*/

customPreview?: CustomPreview | undefined;

}

/**

* @experimental

*/

interface CustomPreview {

header: string;

hasBody: boolean;

formatterObjectId: RemoteObjectId;

bindRemoteObjectFunctionId: RemoteObjectId;

configObjectId?: RemoteObjectId | undefined;

}

/**

* Object containing abbreviated remote object value.

* @experimental

*/

interface ObjectPreview {

/**

* Object type.

*/

type: string;

/**

* Object subtype hint. Specified for <code>object</code> type values only.

*/

subtype?: string | undefined;

/**

* String representation of the object.

*/

description?: string | undefined;

/**

* True iff some of the properties or entries of the original object did not fit.

*/

overflow: boolean;

/**

* List of the properties.

*/

properties: PropertyPreview[];

/**

* List of the entries. Specified for <code>map</code> and <code>set</code> subtype values only.

*/

entries?: EntryPreview[] | undefined;

}

/**

* @experimental

*/

interface PropertyPreview {

/**

* Property name.

*/

name: string;

/**

* Object type. Accessor means that the property itself is an accessor property.

*/

type: string;

/**

* User-friendly property value string.

*/

value?: string | undefined;

/**

* Nested value preview.

*/

valuePreview?: ObjectPreview | undefined;

/**

* Object subtype hint. Specified for <code>object</code> type values only.

*/

subtype?: string | undefined;

}

/**

* @experimental

*/

interface EntryPreview {

/**

* Preview of the key. Specified for map-like collection entries.

*/

key?: ObjectPreview | undefined;

/**

* Preview of the value.

*/

value: ObjectPreview;

}

/**

* Object property descriptor.

*/

interface PropertyDescriptor {

/**

* Property name or symbol description.

*/

name: string;

/**

* The value associated with the property.

*/

value?: RemoteObject | undefined;

/**

* True if the value associated with the property may be changed (data descriptors only).

*/

writable?: boolean | undefined;

/**

* A function which serves as a getter for the property, or <code>undefined</code> if there is no getter (accessor descriptors only).

*/

get?: RemoteObject | undefined;

/**

* A function which serves as a setter for the property, or <code>undefined</code> if there is no setter (accessor descriptors only).

*/

set?: RemoteObject | undefined;

/**

* True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object.

*/

configurable: boolean;

/**

* True if this property shows up during enumeration of the properties on the corresponding object.

*/

enumerable: boolean;

/**

* True if the result was thrown during the evaluation.

*/

wasThrown?: boolean | undefined;

/**

* True if the property is owned for the object.

*/

isOwn?: boolean | undefined;

/**

* Property symbol object, if the property is of the <code>symbol</code> type.

*/

symbol?: RemoteObject | undefined;

}

/**

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

*/

interface InternalPropertyDescriptor {

/**

* Conventional property name.

*/

name: string;

/**

* The value associated with the property.

*/

value?: RemoteObject | undefined;

}

/**

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

*/

interface CallArgument {

/**

* Primitive value or serializable javascript object.

*/

value?: any;

/**

* Primitive value which can not be JSON-stringified.

*/

unserializableValue?: UnserializableValue | undefined;

/**

* Remote object handle.

*/

objectId?: RemoteObjectId | undefined;

}

/**

* Id of an execution context.

*/

type ExecutionContextId = number;

/**

* Description of an isolated world.

*/

interface ExecutionContextDescription {

/**

* Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed.

*/

id: ExecutionContextId;

/**

* Execution context origin.

*/

origin: string;

/**

* Human readable name describing given context.

*/

name: string;

/**

* Embedder-specific auxiliary data.

*/

auxData?: {} | undefined;

}

/**

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

*/

interface ExceptionDetails {

/**

* Exception id.

*/

exceptionId: number;

/**

* Exception text, which should be used together with exception object when available.

*/

text: string;

/**

* Line number of the exception location (0-based).

*/

lineNumber: number;

/**

* Column number of the exception location (0-based).

*/

columnNumber: number;

/**

* Script ID of the exception location.

*/

scriptId?: ScriptId | undefined;

/**

* URL of the exception location, to be used when the script was not reported.

*/

url?: string | undefined;

/**

* JavaScript stack trace if available.

*/

stackTrace?: StackTrace | undefined;

/**

* Exception object if available.

*/

exception?: RemoteObject | undefined;

/**

* Identifier of the context where exception happened.

*/

executionContextId?: ExecutionContextId | undefined;

}

/**

* Number of milliseconds since epoch.

*/

type Timestamp = number;

/**

* Stack entry for runtime errors and assertions.

*/

interface CallFrame {

/**

* JavaScript function name.

*/

functionName: string;

/**

* JavaScript script id.

*/

scriptId: ScriptId;

/**

* JavaScript script name or url.

*/

url: string;

/**

* JavaScript script line number (0-based).

*/

lineNumber: number;

/**

* JavaScript script column number (0-based).

*/

columnNumber: number;

}

/**

* Call frames for assertions or error messages.

*/

interface StackTrace {

/**

* String label of this stack trace. For async traces this may be a name of the function that initiated the async call.

*/

description?: string | undefined;

/**

* JavaScript function name.

*/

callFrames: CallFrame[];

/**

* Asynchronous JavaScript stack trace that preceded this stack, if available.

*/

parent?: StackTrace | undefined;

/**

* Asynchronous JavaScript stack trace that preceded this stack, if available.

* @experimental

*/

parentId?: StackTraceId | undefined;

}

/**

* Unique identifier of current debugger.

* @experimental

*/

type UniqueDebuggerId = string;

/**

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

* @experimental

*/

interface StackTraceId {

id: string;

debuggerId?: UniqueDebuggerId | undefined;

}

interface EvaluateParameterType {

/**

* Expression to evaluate.

*/

expression: string;

/**

* Symbolic group name that can be used to release multiple objects.

*/

objectGroup?: string | undefined;

/**

* Determines whether Command Line API should be available during the evaluation.

*/

includeCommandLineAPI?: boolean | undefined;

/**

* In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state.

*/

silent?: boolean | undefined;

/**

* Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

*/

contextId?: ExecutionContextId | undefined;

/**

* Whether the result is expected to be a JSON object that should be sent by value.

*/

returnByValue?: boolean | undefined;

/**

* Whether preview should be generated for the result.

* @experimental

*/

generatePreview?: boolean | undefined;

/**

* Whether execution should be treated as initiated by user in the UI.

*/

userGesture?: boolean | undefined;

/**

* Whether execution should <code>await</code> for resulting value and return once awaited promise is resolved.

*/

awaitPromise?: boolean | undefined;

}

interface AwaitPromiseParameterType {

/**

* Identifier of the promise.

*/

promiseObjectId: RemoteObjectId;

/**

* Whether the result is expected to be a JSON object that should be sent by value.

*/

returnByValue?: boolean | undefined;

/**

* Whether preview should be generated for the result.

*/

generatePreview?: boolean | undefined;

}

interface CallFunctionOnParameterType {

/**

* Declaration of the function to call.

*/

functionDeclaration: string;

/**

* Identifier of the object to call function on. Either objectId or executionContextId should be specified.

*/

objectId?: RemoteObjectId | undefined;

/**

* Call arguments. All call arguments must belong to the same JavaScript world as the target object.

*/

arguments?: CallArgument[] | undefined;

/**

* In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state.

*/

silent?: boolean | undefined;

/**

* Whether the result is expected to be a JSON object which should be sent by value.

*/

returnByValue?: boolean | undefined;

/**

* Whether preview should be generated for the result.

* @experimental

*/

generatePreview?: boolean | undefined;

/**

* Whether execution should be treated as initiated by user in the UI.

*/

userGesture?: boolean | undefined;

/**

* Whether execution should <code>await</code> for resulting value and return once awaited promise is resolved.

*/

awaitPromise?: boolean | undefined;

/**

* Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.

*/

executionContextId?: ExecutionContextId | undefined;

/**

* Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object.

*/

objectGroup?: string | undefined;

}

interface GetPropertiesParameterType {

/**

* Identifier of the object to return properties for.

*/

objectId: RemoteObjectId;

/**

* If true, returns properties belonging only to the element itself, not to its prototype chain.

*/

ownProperties?: boolean | undefined;

/**

* If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.

* @experimental

*/

accessorPropertiesOnly?: boolean | undefined;

/**

* Whether preview should be generated for the results.

* @experimental

*/

generatePreview?: boolean | undefined;

}

interface ReleaseObjectParameterType {

/**

* Identifier of the object to release.

*/

objectId: RemoteObjectId;

}

interface ReleaseObjectGroupParameterType {

/**

* Symbolic object group name.

*/

objectGroup: string;

}

interface SetCustomObjectFormatterEnabledParameterType {

enabled: boolean;

}

interface CompileScriptParameterType {

/**

* Expression to compile.

*/

expression: string;

/**

* Source url to be set for the script.

*/

sourceURL: string;

/**

* Specifies whether the compiled script should be persisted.

*/

persistScript: boolean;

/**

* Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

*/

executionContextId?: ExecutionContextId | undefined;

}

interface RunScriptParameterType {

/**

* Id of the script to run.

*/

scriptId: ScriptId;

/**

* Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

*/

executionContextId?: ExecutionContextId | undefined;

/**

* Symbolic group name that can be used to release multiple objects.

*/

objectGroup?: string | undefined;

/**

* In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state.

*/

silent?: boolean | undefined;

/**

* Determines whether Command Line API should be available during the evaluation.

*/

includeCommandLineAPI?: boolean | undefined;

/**

* Whether the result is expected to be a JSON object which should be sent by value.

*/

returnByValue?: boolean | undefined;

/**

* Whether preview should be generated for the result.

*/

generatePreview?: boolean | undefined;

/**

* Whether execution should <code>await</code> for resulting value and return once awaited promise is resolved.

*/

awaitPromise?: boolean | undefined;

}

interface QueryObjectsParameterType {

/**

* Identifier of the prototype to return objects for.

*/

prototypeObjectId: RemoteObjectId;

}

interface GlobalLexicalScopeNamesParameterType {

/**

* Specifies in which execution context to lookup global scope variables.

*/

executionContextId?: ExecutionContextId | undefined;

}

interface EvaluateReturnType {

/**

* Evaluation result.

*/

result: RemoteObject;

/**

* Exception details.

*/

exceptionDetails?: ExceptionDetails | undefined;

}

interface AwaitPromiseReturnType {

/**

* Promise result. Will contain rejected value if promise was rejected.

*/

result: RemoteObject;

/**

* Exception details if stack strace is available.

*/

exceptionDetails?: ExceptionDetails | undefined;

}

interface CallFunctionOnReturnType {

/**

* Call result.

*/

result: RemoteObject;

/**

* Exception details.

*/

exceptionDetails?: ExceptionDetails | undefined;

}

interface GetPropertiesReturnType {

/**

* Object properties.

*/

result: PropertyDescriptor[];

/**

* Internal object properties (only of the element itself).

*/

internalProperties?: InternalPropertyDescriptor[] | undefined;

/**

* Exception details.

*/

exceptionDetails?: ExceptionDetails | undefined;

}

interface CompileScriptReturnType {

/**

* Id of the script.

*/

scriptId?: ScriptId | undefined;

/**

* Exception details.

*/

exceptionDetails?: ExceptionDetails | undefined;

}

interface RunScriptReturnType {

/**

* Run result.

*/

result: RemoteObject;

/**

* Exception details.

*/

exceptionDetails?: ExceptionDetails | undefined;

}

interface QueryObjectsReturnType {

/**

* Array with objects.

*/

objects: RemoteObject;

}

interface GlobalLexicalScopeNamesReturnType {

names: string[];

}

interface ExecutionContextCreatedEventDataType {

/**

* A newly created execution context.

*/

context: ExecutionContextDescription;

}

interface ExecutionContextDestroyedEventDataType {

/**

* Id of the destroyed context

*/

executionContextId: ExecutionContextId;

}

interface ExceptionThrownEventDataType {

/**

* Timestamp of the exception.

*/

timestamp: Timestamp;

exceptionDetails: ExceptionDetails;

}

interface ExceptionRevokedEventDataType {

/**

* Reason describing why exception was revoked.

*/

reason: string;

/**

* The id of revoked exception, as reported in <code>exceptionThrown</code>.

*/

exceptionId: number;

}

interface ConsoleAPICalledEventDataType {

/**

* Type of the call.

*/

type: string;

/**

* Call arguments.

*/

args: RemoteObject[];

/**

* Identifier of the context where the call was made.

*/

executionContextId: ExecutionContextId;

/**

* Call timestamp.

*/

timestamp: Timestamp;

/**

* Stack trace captured when the call was made.

*/

stackTrace?: StackTrace | undefined;

/**

* Console context descriptor for calls on non-default console context (not console.*): 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call on named context.

* @experimental

*/

context?: string | undefined;

}

interface InspectRequestedEventDataType {

object: RemoteObject;

hints: {};

}

}

namespace Debugger {

/**

* Breakpoint identifier.

*/

type BreakpointId = string;

/**

* Call frame identifier.

*/

type CallFrameId = string;

/**

* Location in the source code.

*/

interface Location {

/**

* Script identifier as reported in the <code>Debugger.scriptParsed</code>.

*/

scriptId: Runtime.ScriptId;

/**

* Line number in the script (0-based).

*/

lineNumber: number;

/**

* Column number in the script (0-based).

*/

columnNumber?: number | undefined;

}

/**

* Location in the source code.

* @experimental

*/

interface ScriptPosition {

lineNumber: number;

columnNumber: number;

}

/**

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

*/

interface CallFrame {

/**

* Call frame identifier. This identifier is only valid while the virtual machine is paused.

*/

callFrameId: CallFrameId;

/**

* Name of the JavaScript function called on this call frame.

*/

functionName: string;

/**

* Location in the source code.

*/

functionLocation?: Location | undefined;

/**

* Location in the source code.

*/

location: Location;

/**

* JavaScript script name or url.

*/

url: string;

/**

* Scope chain for this call frame.

*/

scopeChain: Scope[];

/**

* <code>this</code> object for this call frame.

*/

this: Runtime.RemoteObject;

/**

* The value being returned, if the function is at return point.

*/

returnValue?: Runtime.RemoteObject | undefined;

}

/**

* Scope description.

*/

interface Scope {

/**

* Scope type.

*/

type: string;

/**

* Object representing the scope. For <code>global</code> and <code>with</code> scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties.

*/

object: Runtime.RemoteObject;

name?: string | undefined;

/**

* Location in the source code where scope starts

*/

startLocation?: Location | undefined;

/**

* Location in the source code where scope ends

*/

endLocation?: Location | undefined;

}

/**

* Search match for resource.

*/

interface SearchMatch {

/**

* Line number in resource content.

*/

lineNumber: number;

/**

* Line with match content.

*/

lineContent: string;

}

interface BreakLocation {

/**

* Script identifier as reported in the <code>Debugger.scriptParsed</code>.

*/

scriptId: Runtime.ScriptId;

/**

* Line number in the script (0-based).

*/

lineNumber: number;

/**

* Column number in the script (0-based).

*/

columnNumber?: number | undefined;

type?: string | undefined;

}

interface SetBreakpointsActiveParameterType {

/**

* New value for breakpoints active state.

*/

active: boolean;

}

interface SetSkipAllPausesParameterType {

/**

* New value for skip pauses state.

*/

skip: boolean;

}

interface SetBreakpointByUrlParameterType {

/**

* Line number to set breakpoint at.

*/

lineNumber: number;

/**

* URL of the resources to set breakpoint on.

*/

url?: string | undefined;

/**

* Regex pattern for the URLs of the resources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code> must be specified.

*/

urlRegex?: string | undefined;

/**

* Script hash of the resources to set breakpoint on.

*/

scriptHash?: string | undefined;

/**

* Offset in the line to set breakpoint at.

*/

columnNumber?: number | undefined;

/**

* Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.

*/

condition?: string | undefined;

}

interface SetBreakpointParameterType {

/**

* Location to set breakpoint in.

*/

location: Location;

/**

* Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true.

*/

condition?: string | undefined;

}

interface RemoveBreakpointParameterType {

breakpointId: BreakpointId;

}

interface GetPossibleBreakpointsParameterType {

/**

* Start of range to search possible breakpoint locations in.

*/

start: Location;

/**

* End of range to search possible breakpoint locations in (excluding). When not specified, end of scripts is used as end of range.

*/

end?: Location | undefined;

/**

* Only consider locations which are in the same (non-nested) function as start.

*/

restrictToFunction?: boolean | undefined;

}

interface ContinueToLocationParameterType {

/**

* Location to continue to.

*/

location: Location;

targetCallFrames?: string | undefined;

}

interface PauseOnAsyncCallParameterType {

/**

* Debugger will pause when async call with given stack trace is started.

*/

parentStackTraceId: Runtime.StackTraceId;

}

interface StepIntoParameterType {

/**

* Debugger will issue additional Debugger.paused notification if any async task is scheduled before next pause.

* @experimental

*/

breakOnAsyncCall?: boolean | undefined;

}

interface GetStackTraceParameterType {

stackTraceId: Runtime.StackTraceId;

}

interface SearchInContentParameterType {

/**

* Id of the script to search in.

*/

scriptId: Runtime.ScriptId;

/**

* String to search for.

*/

query: string;

/**

* If true, search is case sensitive.

*/

caseSensitive?: boolean | undefined;

/**

* If true, treats string parameter as regex.

*/

isRegex?: boolean | undefined;

}

interface SetScriptSourceParameterType {

/**

* Id of the script to edit.

*/

scriptId: Runtime.ScriptId;

/**

* New content of the script.

*/

scriptSource: string;

/**

* If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code.

*/

dryRun?: boolean | undefined;

}

interface RestartFrameParameterType {

/**

* Call frame identifier to evaluate on.

*/

callFrameId: CallFrameId;

}

interface GetScriptSourceParameterType {

/**

* Id of the script to get source for.

*/

scriptId: Runtime.ScriptId;

}

interface SetPauseOnExceptionsParameterType {

/**

* Pause on exceptions mode.

*/

state: string;

}

interface EvaluateOnCallFrameParameterType {

/**

* Call frame identifier to evaluate on.

*/

callFrameId: CallFrameId;

/**

* Expression to evaluate.

*/

expression: string;

/**

* String object group name to put result into (allows rapid releasing resulting object handles using <code>releaseObjectGroup</code>).

*/

objectGroup?: string | undefined;

/**

* Specifies whether command line API should be available to the evaluated expression, defaults to false.

*/

includeCommandLineAPI?: boolean | undefined;

/**

* In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides <code>setPauseOnException</code> state.

*/

silent?: boolean | undefined;

/**

* Whether the result is expected to be a JSON object that should be sent by value.

*/

returnByValue?: boolean | undefined;

/**

* Whether preview should be generated for the result.

* @experimental