Class WebsocketStreams

Index

Constructors

Methods

Constructors

constructor

new WebsocketStreams(
configuration: ConfigurationWebsocketStreams,
): MarginTradingWebsocketStreams.WebsocketStreams
Parameters
- configuration: ConfigurationWebsocketStreams
Returns MarginTradingWebsocketStreams.WebsocketStreams
- Defined in clients/margin-trading/src/websocket-streams/websocket-streams.ts:20

Methods

connect

connect(
    options?: {
        mode?: "single" | "pool";
        poolSize?: number;
        stream?: string | string[];
    },
): Promise<MarginTradingWebsocketStreams.WebsocketStreamsConnection>
Connects to the Binance WebSocket streams and returns a WebsocketStreamsConnection instance.
Parameters
- Optionaloptions: { mode?: "single" | "pool"; poolSize?: number; stream?: string | string[] } = {}
  Optional connection options.
  - Optionalmode?: "single" | "pool"
    The connection mode, either 'single' or 'pool'. Overwrite the mode option in the configuration.
  - OptionalpoolSize?: number
    The number of connections to use in pool mode. Overwrite the poolSize option in the configuration.
  - Optionalstream?: string | string[]
    The stream(s) to connect to.
Returns Promise<MarginTradingWebsocketStreams.WebsocketStreamsConnection>
- A promise that resolves to a WebsocketStreamsConnection instance.
- Defined in clients/margin-trading/src/websocket-streams/websocket-streams.ts:33