Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "inspector"

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

Index

Modules

Classes

Interfaces

Functions

Functions

close

  • close(): void

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

    Returns void

open

  • open(port?: number, host?: string, wait?: boolean): void

  • Activate inspector on host and port. Equivalent to node --inspect=[[host:]port], but can be done programatically after node has started. If wait is true, will block until a client has connected to the inspect port and flow control has been passed to the debugger client.

    Parameters

    • Optional port: number

      Port to listen on for inspector connections. Optional, defaults to what was specified on the CLI.

    • Optional host: string

      Host to listen on for inspector connections. Optional, defaults to what was specified on the CLI.

    • Optional wait: boolean

      Block until a client has connected. Optional, defaults to false.

    Returns void

url

  • url(): string | undefined

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

    Returns string | undefined

waitForDebugger

  • waitForDebugger(): void

  • Blocks until a client (existing or connected later) has sent Runtime.runIfWaitingForDebugger command. An exception will be thrown if there is no active inspector.

    Returns void

Generated using TypeDoc