API Reference

---

API Reference / MarketDepthWSOptions

Interface: MarketDepthWSOptions

Defined in: src/types/ws.types.ts:146

Properties

token?

optional token?: string

Defined in: src/types/ws.types.ts:147

---

clientId

clientId: string

Defined in: src/types/ws.types.ts:148

---

url?

optional url?: string

Defined in: src/types/ws.types.ts:149

---

reconnectDelayMs?

optional reconnectDelayMs?: number

Defined in: src/types/ws.types.ts:150

---

maxReconnectDelayMs?

optional maxReconnectDelayMs?: number

Defined in: src/types/ws.types.ts:151

---

maxReconnectAttempts?

optional maxReconnectAttempts?: number

Defined in: src/types/ws.types.ts:152

---

mode?

optional mode?: MarketDepthMode

Defined in: src/types/ws.types.ts:153

---

webSocketFactory?

optional webSocketFactory?: (url) => WebSocketLike

Defined in: src/types/ws.types.ts:154

Parameters

url

string

Returns

WebSocketLike

---

tokenProvider?

optional tokenProvider?: () => string | Promise<string>

Defined in: src/types/ws.types.ts:155

Returns

string | Promise<string>