API Reference

---

API Reference / BaseWS

Abstract Class: BaseWS

Defined in: src/ws/BaseWS.ts:6

Extends

• EventEmitter

Extended by

• MarketDepthWS
• MarketFeedWS
• OrderUpdateWS

Constructors

Constructor

new BaseWS(urlFactory, reconnectDelayMs, webSocketFactory, maxReconnectDelayMs?, maxReconnectAttempts?, logger?): BaseWS

Defined in: src/ws/BaseWS.ts:23

Parameters

urlFactory

() => string | Promise<string>

reconnectDelayMs

number

webSocketFactory

(url) => WebSocketLike

maxReconnectDelayMs?

number

maxReconnectAttempts?

number

logger?

Logger

Returns

BaseWS

Overrides

EventEmitter.constructor

Properties

connection?

protected optional connection?: WebSocketLike

Defined in: src/ws/BaseWS.ts:8

---

manuallyClosed

protected manuallyClosed: boolean = false

Defined in: src/ws/BaseWS.ts:9

---

reconnectAttempts

protected reconnectAttempts: number = 0

Defined in: src/ws/BaseWS.ts:10

---

isConnected

isConnected: boolean = false

Defined in: src/ws/BaseWS.ts:11

---

logger?

protected optional logger?: Logger

Defined in: src/ws/BaseWS.ts:12

Methods

connect()

connect(): Promise<void>

Defined in: src/ws/BaseWS.ts:37

Returns

Promise<void>

---

disconnect()

disconnect(): void

Defined in: src/ws/BaseWS.ts:51

Returns

void

---

send()

protected send(payload): void

Defined in: src/ws/BaseWS.ts:61

Parameters

payload

string | Buffer<ArrayBufferLike>

Returns

void

---

onOpen()

abstract protected onOpen(): void | Promise<void>

Defined in: src/ws/BaseWS.ts:163

Returns

void | Promise<void>

---

onMessage()

abstract protected onMessage(data): void

Defined in: src/ws/BaseWS.ts:164

Parameters

data

unknown

Returns

void

---

onClose()

abstract protected onClose(): void

Defined in: src/ws/BaseWS.ts:165

Returns

void