Skip to main content

WebSocketClient

@totemsdk/server


@totemsdk/server / WebSocketClient

Interface: WebSocketClient

Properties

onclose

onclose: ((ev) => void) | null


onerror

onerror: ((ev) => void) | null


onmessage

onmessage: ((ev) => void) | null


onopen

onopen: ((ev) => void) | null


readyState

readonly readyState: number


url

readonly url: string

Methods

addEventListener()

addEventListener<K>(event, listener): void

Type Parameters

K

K extends keyof WebSocketEventMap

Parameters

event

K

listener

(ev) => void

Returns

void


close()

close(code?, reason?): void

Parameters

code?

number

reason?

string

Returns

void


removeAllListeners()

removeAllListeners(): void

Returns

void


removeEventListener()

removeEventListener<K>(event, listener): void

Type Parameters

K

K extends keyof WebSocketEventMap

Parameters

event

K

listener

(ev) => void

Returns

void


send()

send(data): void

Parameters

data

string | BinaryData

Returns

void


terminate()

terminate(): void

Returns

void