Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / WebSocketCloseInfo

Interface: WebSocketCloseInfo ​

Defined in: packages/ts-sdk/src/internal/errors.ts:84

Close-frame facts extracted from a browser-style close event.

Example:

ts
import type { WebSocketCloseInfo } from '@my-swu/simulator-client'

const webSocketCloseInfo: WebSocketCloseInfo = {}

console.log(webSocketCloseInfo)

Properties ​

closeCode? ​

Example:

ts
import type { WebSocketCloseInfo } from '@my-swu/simulator-client'

const webSocketCloseInfo: WebSocketCloseInfo = {}

const { closeCode } = webSocketCloseInfo

console.log(closeCode)

optional closeCode?: number

Defined in: packages/ts-sdk/src/internal/errors.ts:86

Close status code when the transport exposed one.


reason? ​

Example:

ts
import type { WebSocketCloseInfo } from '@my-swu/simulator-client'

const webSocketCloseInfo: WebSocketCloseInfo = {}

const { reason } = webSocketCloseInfo

console.log(reason)

optional reason?: string

Defined in: packages/ts-sdk/src/internal/errors.ts:88

UTF-8 close reason when the transport exposed one.

Released under the MIT License.