DevtoolsWrapperConfig
interfaceConfiguration for the browser DevTools store wrapper (withDevtools).
Controls how the browser agent connects to the DevTools hub, which
capabilities it advertises (replay, emit), and reconnection behaviour.
All fields except
port are optional and have sensible defaults.Properties
| Name | Type | Description |
|---|---|---|
allowEmit? | boolean | Allow DevTools extensions to emit events to this store. |
allowReplay? | boolean | Enable event replay capability. |
authToken? | string | Shared secret required by a hub that was started with one. |
autoReconnect? | boolean | Automatically reconnect to the hub on disconnect. |
baseDelay? | number | Base delay for exponential reconnection backoff (ms). |
host? | string | Hub server host. |
maxDelay? | number | Maximum delay cap for reconnection backoff (ms). |
maxEventBytes? | number | Byte cap for a single event payload or patch value. |
maxReconnectAttempts? | number | Maximum number of reconnection attempts before giving up. |
maxSnapshotBytes? | number | Byte budget for a state snapshot before parts of it are omitted. |
port | number | Hub server port. Required. |
sampling? | SamplingConfig | Which events the agent forwards to the hub. |
sanitize? | (path: string, value: unknown) => unknown | Redacts a value before it leaves the process. |
socketFactory? | DevtoolsSocketFactory | Custom socket factory (advanced). By default the agent opens a native
browser WebSocket. Inject a different transport, e.g. an in-memory
loopback for an embedded panel or a test, to connect the agent without a
real network socket. |
storeId? | string | Store identifier presented to the hub, kept across reconnects. |
throttleMs? | number | Throttle interval for DevTools updates (ms). 0 disables throttling. |
transport? | "auto" | "bridge" | "websocket" | How the agent reaches the panel. |