API Reference

---

API Reference / OrderUpdateWSOptionsWithLogger

Interface: OrderUpdateWSOptionsWithLogger

Defined in: src/ws/OrderUpdateWS.ts:13

Extends

• OrderUpdateWSOptions

Properties

token?

optional token?: string

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

Inherited from

OrderUpdateWSOptions.token

---

clientId

clientId: string

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

Inherited from

OrderUpdateWSOptions.clientId

---

url?

optional url?: string

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

Inherited from

OrderUpdateWSOptions.url

---

reconnectDelayMs?

optional reconnectDelayMs?: number

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

Inherited from

OrderUpdateWSOptions.reconnectDelayMs

---

maxReconnectDelayMs?

optional maxReconnectDelayMs?: number

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

Inherited from

OrderUpdateWSOptions.maxReconnectDelayMs

---

maxReconnectAttempts?

optional maxReconnectAttempts?: number

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

Inherited from

OrderUpdateWSOptions.maxReconnectAttempts

---

webSocketFactory?

optional webSocketFactory?: (url) => WebSocketLike

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

Parameters

url

string

Returns

WebSocketLike

Inherited from

OrderUpdateWSOptions.webSocketFactory

---

tokenProvider?

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

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

Returns

string | Promise<string>

Inherited from

OrderUpdateWSOptions.tokenProvider

---

userType?

optional userType?: "SELF" | "PARTNER"

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

Inherited from

OrderUpdateWSOptions.userType

---

partnerId?

optional partnerId?: string

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

Inherited from

OrderUpdateWSOptions.partnerId

---

partnerSecret?

optional partnerSecret?: string

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

Inherited from

OrderUpdateWSOptions.partnerSecret

---

logger?

optional logger?: Logger

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