Interface: DarkWsOptions

Defined in: packages/darkws/src/dark-ws.ts:11

Properties

authenticationToken?

optional authenticationToken?: () => string | Promise<string | null | undefined> | null | undefined

Defined in: packages/darkws/src/dark-ws.ts:18

Returns

string | Promise<string | null | undefined> | null | undefined

---

beforeConnect?

optional beforeConnect?: () => Promise<unknown>

Defined in: packages/darkws/src/dark-ws.ts:17

Returns

Promise<unknown>

---

canConnect?

optional canConnect?: () => boolean

Defined in: packages/darkws/src/dark-ws.ts:16

Returns

boolean

---

controlTimeout?

optional controlTimeout?: number

Defined in: packages/darkws/src/dark-ws.ts:25

Reply timeout for authentication and logout, including session restore. Default 30000 ms; 0 disables it.

---

debug?

optional debug?: boolean

Defined in: packages/darkws/src/dark-ws.ts:35

---

host?

optional host?: string

Defined in: packages/darkws/src/dark-ws.ts:12

---

maxPendingRequests?

optional maxPendingRequests?: number

Defined in: packages/darkws/src/dark-ws.ts:21

Maximum pending request/authenticate/logout calls, including waits and retries. Default 256; positive safe integer.

---

path

path: string

Defined in: packages/darkws/src/dark-ws.ts:13

---

pingInterval?

optional pingInterval?: number

Defined in: packages/darkws/src/dark-ws.ts:30

---

pingTimeout?

optional pingTimeout?: number

Defined in: packages/darkws/src/dark-ws.ts:32

Deprecated

Use pingInterval: this value is the interval between pings, not a timeout.

---

pongTimeout?

optional pongTimeout?: number

Defined in: packages/darkws/src/dark-ws.ts:33

---

query?

optional query?: Record<string, string> | (() => Record<string, string>)

Defined in: packages/darkws/src/dark-ws.ts:14

---

reconnect?

optional reconnect?: boolean

Defined in: packages/darkws/src/dark-ws.ts:26

---

reconnectOnVisible?

optional reconnectOnVisible?: boolean

Defined in: packages/darkws/src/dark-ws.ts:29

Retry a pending automatic reconnect immediately when the document becomes visible. Default false.

---

reconnectTimeout?

optional reconnectTimeout?: number

Defined in: packages/darkws/src/dark-ws.ts:27

---

requestOptions?

optional requestOptions?: (action) => DarkWsRequestOptions | undefined

Defined in: packages/darkws/src/dark-ws.ts:23

Default options per action; explicit request options override them field by field. Not used by authenticate/logout.

Parameters

action

string

Returns

DarkWsRequestOptions | undefined

---

requestTimeout?

optional requestTimeout?: number

Defined in: packages/darkws/src/dark-ws.ts:19

---

secure

secure: boolean

Defined in: packages/darkws/src/dark-ws.ts:15

---

waitConnectionTimeout?

optional waitConnectionTimeout?: number

Defined in: packages/darkws/src/dark-ws.ts:34