Class WebSocketTransport`Abstract`

Abstract WebSocket transport. Implement the abstract methods for your specific WS library (Centrifugo, Socket.IO, native WebSocket, etc.)

Implements

DataTransport

Index

Constructors

Properties

_config _onUpdate

Methods

connect destroy fetchHistory parseCandles subscribe subscribeChannel unsubscribe unsubscribeChannel

Constructors

constructor

new WebSocketTransport(): WebSocketTransport
Returns WebSocketTransport

Properties

`Protected`_config

_config: DataFeedConfig | null = null

`Protected`_onUpdate

_onUpdate: ((candles: Candle[]) => void) | null = null

Methods

`Abstract`connect

connect(url: string): void
Connect to the WebSocket server
Parameters
- url: string
Returns void
- Defined in data/WebSocketTransport.ts:12

destroy

destroy(): void
Release all resources (close socket, abort fetch, clear timers).

Returns void
Implementation of DataTransport.destroy
- Defined in data/WebSocketTransport.ts:52

`Abstract`fetchHistory

fetchHistory(req: HistoryRequest): Promise<Candle[]>
Fetch historical data (typically via HTTP, not WS)
Parameters
- req: HistoryRequest
Returns Promise<Candle[]>
Implementation of DataTransport.fetchHistory
- Defined in data/WebSocketTransport.ts:21

`Protected`parseCandles

parseCandles(data: unknown): Candle[]
Parse incoming WS data into Candle array
Parameters
- data: unknown
Returns Candle[]
- Defined in data/WebSocketTransport.ts:24

subscribe(config: DataFeedConfig, onUpdate: (candles: Candle[]) => void): void
Start a live stream. onUpdate is called with new/updated candles.
Parameters
- config: DataFeedConfig
- onUpdate: (candles: Candle[]) => void
Returns void
Implementation of DataTransport.subscribe
- Defined in data/WebSocketTransport.ts:31

`Abstract`subscribeChannel

subscribeChannel(channel: string, handler: (data: unknown) => void): void
Subscribe to a specific channel/topic
Parameters
- channel: string
- handler: (data: unknown) => void
Returns void
- Defined in data/WebSocketTransport.ts:15

unsubscribe

unsubscribe(): void
Stop a live stream started by subscribe.

Returns void
Implementation of DataTransport.unsubscribe
- Defined in data/WebSocketTransport.ts:43

`Abstract`unsubscribeChannel

unsubscribeChannel(channel: string): void
Unsubscribe from a channel
Parameters
- channel: string
Returns void
- Defined in data/WebSocketTransport.ts:18