Skip to content

DevtoolsOption

DevtoolsOption = boolean | { allowInProduction?: boolean; allowRemote?: boolean; enabled: boolean; path?: string; token?: string; }

Defined in: devtools/server.ts:48

The devtools server option (ADR 0011). Off by default.

  • true enables the inspector outside production (NODE_ENV !== 'production') with a generated token; in production it is ignored with a warning.
  • In production, enabling needs { enabled: true, allowInProduction: true, token } with a token of at least 32 characters, otherwise createServer throws.

boolean


{ allowInProduction?: boolean; allowRemote?: boolean; enabled: boolean; path?: string; token?: string; }

optional allowInProduction?: boolean

Allow devtools when NODE_ENV === 'production'. Default false.

optional allowRemote?: boolean

Serve non-loopback clients too. Default false: loopback clients only.

enabled: boolean

optional path?: string

HTTP path of the inspector. Default '/__shoehive'; the socket is <path>/ws.

optional token?: string

Required in production; generated (32 random bytes) in dev if omitted.