API Reference

---

API Reference / OrderUpdateWSOptions

Interface: OrderUpdateWSOptions

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

Extended by

• OrderUpdateWSOptionsWithLogger

Properties

token?

optional token?: string

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

---

clientId

clientId: string

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

---

url?

optional url?: string

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

---

reconnectDelayMs?

optional reconnectDelayMs?: number

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

---

maxReconnectDelayMs?

optional maxReconnectDelayMs?: number

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

---

maxReconnectAttempts?

optional maxReconnectAttempts?: number

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

---

webSocketFactory?

optional webSocketFactory?: (url) => WebSocketLike

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

Parameters

url

string

Returns

WebSocketLike

---

tokenProvider?

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

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

Returns

string | Promise<string>

---

userType?

optional userType?: "SELF" | "PARTNER"

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

---

partnerId?

optional partnerId?: string

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

---

partnerSecret?

optional partnerSecret?: string

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