ProtectedconfigurationProtectedconnectionOptionalsignedOptionalstreamProtectedurlProtectedwsProtectedcleanupThe WebSocket client to clean up.
void
ProtectedclearClears all timers associated with a WebSocket connection.
The WebSocket client instance to clear timers for.
void
Connects to the WebSocket Streams endpoint.
apiKey supplied): fetches a fresh auth token from the
REST API, stores it, and schedules a 6-day renewal timer. The token is appended
to the WebSocket URL on every connectionwsToken supplied): uses the provided token
directly. No REST call is made and no renewal timer is started.Optionalstream: string | string[]
Stream name(s) to subscribe immediately after connect.
A promise that resolves when the connection is established.
ProtectedconnectConnects all WebSocket connections in the pool
The Websocket server URL.
Optionalconnections: WebsocketConnection[]
An optional array of WebSocket connections to connect. If not provided, all connections in the pool are connected.
A promise that resolves when all connections are established.
ProtectedcreateCreates a new WebSocket client instance.
The URL to connect to.
A new WebSocket client instance.
Disconnects from the WebSocket Streams endpoint and clears the token renewal timer (no-op in bring-your-own-token mode since no timer is started there).
A promise that resolves when the disconnection is complete.
ProtectedemitProtectedenqueueEnqueues a reconnection or renewal for a WebSocket connection.
This method adds the connection, URL, and renewal flag to the connection queue,
and then calls the processQueue method to initiate the reconnection or renewal
process.
The WebSocket connection to reconnect or renew.
The URL to use for the reconnection or renewal.
A flag indicating whether this is a renewal (true) or a reconnection (false).
ProtectedgetRetrieves available WebSocket connections based on the connection mode and readiness. In 'single' mode, returns the first connection in the pool. In 'pool' mode, filters and returns connections that are ready for use.
OptionalallowNonEstablishedWebsockets: boolean
Optional flag to include non-established WebSocket connections.
OptionalurlPath: string
Optional URL path to filter connections.
An array of available WebSocket connections.
ProtectedgetGets a WebSocket connection from the pool or single connection. If the connection mode is 'single', it returns the first connection in the pool. If the connection mode is 'pool', it returns an available connection from the pool, using a round-robin selection strategy. If no available connections are found, it throws an error.
OptionalallowNonEstablishedWebsockets: boolean
A boolean indicating whether to allow connections that are not established.
OptionalurlPath: string
An optional URL path to filter connections.
The selected WebSocket connection.
ProtectedgetReturns the additional handshake headers. For signed streams the X-MBX-APIKEY header is added.
A record of header names and values.
ProtectedgetFormats the WebSocket URL with stream and configuration parameters to be used for reconnection.
The base WebSocket URL.
The target WebSocket connection.
The formatted WebSocket URL with streams and optional parameters.
ProtectedinitOverrides the base class's initConnect method to append the current auth token
to the WebSocket URL as a query parameter. This is called both on the initial
connection and on every server-driven 23-hour renewal — in both cases the token
already in memory is reused (no extra fetch).
The WebSocket URL to connect to.
Whether this is a connection renewal.
Optionalconnection: WebsocketConnection
Optional existing connection to reuse.
A WebsocketConnection instance, or undefined.
Checks if the WebSocket connection is currently open.
Optionalconnection: WebsocketConnection
An optional WebSocket connection to check. If not provided, the entire connection pool is checked.
true if the connection is open, false otherwise.
ProtectedisChecks if the provided WebSocket connection is ready for use. A connection is considered ready if it is open, has no pending reconnection, and has not been closed.
The WebSocket connection to check.
OptionalallowNonEstablishedWebsockets: boolean
An optional flag to allow non-established WebSocket connections.
true if the connection is ready, false otherwise.
ProtectedisChecks if the message is serverShutdown.
This is used to identify server shutdown events in incoming WebSocket messages.
The message to check for a server shutdown event.
true if the message indicates a server shutdown event, false otherwise.
Checks if the specified stream is currently subscribed.
The name of the stream to check.
true if the stream is currently subscribed, false otherwise.
ProtectedonHandles incoming WebSocket messages, parsing the data and invoking the appropriate callback function.
If the message contains a stream name that is registered in the streamCallbackMap, the corresponding
callback function is called with the message data.
If the message cannot be parsed, an error is logged.
The raw WebSocket message data.
The WebSocket connection that received the message.
ProtectedonCalled when the WebSocket connection is opened. Processes any pending subscriptions for the target connection.
The URL of the WebSocket connection.
The WebSocket connection that was opened.
ProtectedscheduleSchedules a timer for a WebSocket connection and tracks it
WebSocket client instance
Function to execute when timer triggers
Time in milliseconds before callback execution
Optionaltype: "timeout" | "interval"
Timer type ('timeout' or 'interval')
Timer handle
ProtectedsendSends a payload through the WebSocket connection.
Message to send.
Optionalid: string
Optional request identifier.
OptionalpromiseBased: boolean
Whether to return a promise.
Optionaltimeout: number
Timeout duration in milliseconds.
Optionalconnection: WebsocketConnection
The WebSocket connection to use.
A promise if promiseBased is true, void otherwise.
Generates a stream key by combining a stream name with an optional URL path.
The stream name to use as the key or suffix.
OptionalurlPath: string
Optional URL path to prepend to the stream name.
A stream key in the format urlPath::stream if urlPath is provided, otherwise just the stream name.
Subscribes to one or multiple WebSocket streams Handles both single and pool modes
Single stream name or array of stream names to subscribe to
Optionalid: string | number
Optional subscription ID
OptionalurlPath: string
Optional URL path for the streams
void
Unsubscribes from one or multiple WebSocket streams Handles both single and pool modes
Single stream name or array of stream names to unsubscribe from
Optionalid: string | number
Optional unsubscription ID
OptionalurlPath: string
Optional URL path for the streams
void
Cleans up WebSocket connection resources. Removes all listeners and clears any associated timers for the provided WebSocket client.