インターフェース: 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/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?	object
cause.code?	number

戻り値

void

ソース

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

---

onOpen

optional onOpen: () => void

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

戻り値

void

ソース

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

---

retryDelayMs

optional retryDelayMs: (attemptIndex) => number

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

デフォルト

ts
{@link exponentialBackoff}

ts
{@link exponentialBackoff}

パラメーター

パラメーター	型
attemptIndex	number

戻り値

number

ソース

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を使用して生成