Class WebsocketAPI

Index

Constructors

Methods

Constructors

constructor

new WebsocketAPI(
configuration: ConfigurationWebsocketAPI,
): SpotWebsocketAPI.WebsocketAPI
Parameters
- configuration: ConfigurationWebsocketAPI
Returns SpotWebsocketAPI.WebsocketAPI
- Defined in clients/spot/src/websocket-api/websocket-api.ts:25

Methods

connect

connect(
options?: { mode?: "single" | "pool"; poolSize?: number },
): Promise<SpotWebsocketAPI.WebsocketAPIConnection>
Connects to the Binance WebSocket API and returns a WebsocketAPIConnection instance.
Parameters
- Optionaloptions: { mode?: "single" | "pool"; poolSize?: number } = {}
  Optional connection options.
  - Optionalmode?: "single" | "pool"
    The connection mode, either 'single' or 'pool'. Overrides the mode property in the configuration.
  - OptionalpoolSize?: number
    The number of connections to use in pool mode. Overrides the poolSize property in the configuration.
Returns Promise<SpotWebsocketAPI.WebsocketAPIConnection>
- A promise that resolves to a WebsocketAPIConnection instance.
- Defined in clients/spot/src/websocket-api/websocket-api.ts:37