API Reference

---

API Reference / MarketDepthWS

Class: MarketDepthWS

Defined in: src/ws/MarketDepthWS.ts:14

Extends

• BaseWS

Constructors

Constructor

new MarketDepthWS(options): MarketDepthWS

Defined in: src/ws/MarketDepthWS.ts:18

Parameters

options

MarketDepthWSOptions

Returns

MarketDepthWS

Overrides

BaseWS.constructor

Properties

connection?

protected optional connection?: WebSocketLike

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

Inherited from

BaseWS.connection

---

manuallyClosed

protected manuallyClosed: boolean = false

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

Inherited from

BaseWS.manuallyClosed

---

reconnectAttempts

protected reconnectAttempts: number = 0

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

Inherited from

BaseWS.reconnectAttempts

---

isConnected

isConnected: boolean = false

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

Inherited from

BaseWS.isConnected

---

logger?

protected optional logger?: Logger

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

Inherited from

BaseWS.logger

Methods

connect()

connect(): Promise<void>

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

Returns

Promise<void>

Inherited from

BaseWS.connect

---

disconnect()

disconnect(): void

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

Returns

void

Inherited from

BaseWS.disconnect

---

send()

protected send(payload): void

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

Parameters

payload

string | Buffer<ArrayBufferLike>

Returns

void

Inherited from

BaseWS.send

---

subscribe()

subscribe(instruments): void

Defined in: src/ws/MarketDepthWS.ts:44

Parameters

instruments

InstrumentSubscription[]

Returns

void

---

unsubscribe()

unsubscribe(instruments): void

Defined in: src/ws/MarketDepthWS.ts:54

Parameters

instruments

InstrumentSubscription[]

Returns

void

---

getSubscriptions()

getSubscriptions(): InstrumentSubscription[]

Defined in: src/ws/MarketDepthWS.ts:60

Returns

InstrumentSubscription[]

---

onOpen()

protected onOpen(): void

Defined in: src/ws/MarketDepthWS.ts:64

Returns

void

Overrides

BaseWS.onOpen

---

onMessage()

protected onMessage(data): void

Defined in: src/ws/MarketDepthWS.ts:73

Parameters

data

unknown

Returns

void

Overrides

BaseWS.onMessage

---

onClose()

protected onClose(): void

Defined in: src/ws/MarketDepthWS.ts:95

Returns

void

Overrides

BaseWS.onClose