インターフェース: WebSocketClientOptions

プロパティ

WebSocket

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

どの WebSocket 実装を使用するかを指定します。

パラメーター

パラメーター	型
url	string | URL
protocols?	string | string[]

戻り値

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/src/links/wsLink.ts:44

---

lazy

optional lazy: object

レジーモードでは、一定期間（メッセージの送受信がなく、保留中のリクエストがない状態）アイドル状態になると、WebSocket は自動的に閉じられます。

型定義

lazy.closeMs

closeMs: number

このミリ秒後に WebSocket を閉じます。

デフォルト

ts
0

ts
0

lazy.enabled

enabled: boolean

レジーモードを有効にします。

デフォルト

ts
false

ts
false

ソース

packages/client/src/links/wsLink.ts:61

---

onClose

optional onClose: (cause?) => void

WebSocket 接続が閉じられたときにトリガーされます。

パラメーター

パラメーター	型
cause?	object
cause.code?	number

戻り値

void

ソース

packages/client/src/links/wsLink.ts:57

---

onOpen

optional onOpen: () => void

WebSocket 接続が確立されたときにトリガーされます。

戻り値

void

ソース

packages/client/src/links/wsLink.ts:53

---

retryDelayMs

optional retryDelayMs: (attemptIndex) => number

再接続を試行するまでのミリ秒数。

デフォルト

ts
{@link exponentialBackoff}

ts
{@link exponentialBackoff}

パラメーター

パラメーター	型
attemptIndex	number

戻り値

number

ソース

packages/client/src/links/wsLink.ts:49

---

url

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

接続先のURL（URLを返す関数にすることもできます）

ソース

packages/client/src/links/wsLink.ts:40

---

TypeDoc と typedoc-plugin-markdown を使用して生成されました。