接口: WebSocketClientOptions

属性

WebSocket

optional WebSocket: (url, protocols?) => WebSocket

要使用的 WebSocket 实现的 Ponyfill

参数

参数	类型
url	字符串 | URL
协议?	字符串 | 字符串[]

返回值

WebSocket

类型声明

WebSocket.CLOSED

readonly CLOSED: 3

WebSocket.CLOSING

readonly CLOSING: 2

WebSocket.CONNECTING

readonly CONNECTING: 0

WebSocket.OPEN

readonly OPEN: 1

WebSocket.prototype

prototype: WebSocket

来源

packages/client/dist/links/wsLink.d.ts:17

---

lazy

optional lazy: object

惰性模式将在一段时间不活动后自动关闭 WebSocket（没有发送或接收消息，也没有待处理的请求）

类型声明

lazy.closeMs

closeMs: number

在这么多毫秒后关闭 WebSocket

默认值

ts
0

ts
0

lazy.enabled

enabled: boolean

启用惰性模式

默认值

ts
false

ts
false

来源

packages/client/dist/links/wsLink.d.ts:36

---

onClose

optional onClose: (cause?) => void

在 WebSocket 连接关闭时触发

参数

参数	类型
原因?	对象
cause.code?	数字

返回值

空

来源

packages/client/dist/links/wsLink.d.ts:30

---

onOpen

optional onOpen: () => void

在建立 WebSocket 连接时触发

返回值

空

来源

packages/client/dist/links/wsLink.d.ts:26

---

retryDelayMs

optional retryDelayMs: (attemptIndex) => number

尝试重新连接之前的毫秒数。

默认值

ts
{@link exponentialBackoff}

ts
{@link exponentialBackoff}

参数

参数	类型
尝试索引	数字

返回值

数字

来源

packages/client/dist/links/wsLink.d.ts:22

---

url

url: string|() => MaybePromise< string>

要连接的 URL（可以是返回 URL 的函数）

来源

packages/client/dist/links/wsLink.d.ts:13

---

使用 TypeDoc 和 typedoc-plugin-markdown 生成