Skip to content
Wildloop Wildloop

getDebugState

const getDebugState: any = addon.getDebugState

Defined in: index.cts:576

Retrieves debug state information about the internal WarpSocket data structures.

Param

Section titled “Param”

mode

The type of data to retrieve: “channels” for channel subscriptions, “sockets” for socket details, “workers” for worker thread info, “kv” for key-value store entries.

Param

Section titled “Param”

singleKey

Optional. When provided, returns only the data for a specific item: for “channels”, a channel name (bytes) or socket ID (number); for “sockets” and “workers”, a socket ID or worker ID (number); for “kv”, a key (bytes).

Returns

Section titled “Returns”

For “channels” and “kv”, an array of objects with detailed state information, capped at 2000 entries. For “sockets” and “workers”, an object keyed by socketId/workerId with values being the debug info objects. When singleKey is provided, a single object or undefined is returned instead of an array/object (except when mode is “channels” and singleKey is a number).