Skip to main content

IQWebSocketClientSocket

@quik/websocket

@quik/websocket / IQWebSocketClientSocket

Interface: IQWebSocketClientSocket

Defined in: websocket/src/types.ts:62

Browser and app compatible WebSocket shape used by the client heartbeat helper.

Properties​

readyState?​

optional readyState?: number

Defined in: websocket/src/types.ts:64

Browser-compatible ready state.

Methods​

addEventListener()?​

optional addEventListener(event, listener): void

Defined in: websocket/src/types.ts:78

Parameters​

event​

"message"

listener​

(event) => void

Returns​

void

close()​

close(code?, reason?): void

Defined in: websocket/src/types.ts:77

Closes the socket.

Parameters​

code?​

number

WebSocket close code.

reason?​

string

Optional close reason.

Returns​

void

off()?​

optional off(event, listener): void

Defined in: websocket/src/types.ts:81

Parameters​

event​

"message"

listener​

(data) => void

Returns​

void

on()?​

optional on(event, listener): void

Defined in: websocket/src/types.ts:80

Parameters​

event​

"message"

listener​

(data) => void

Returns​

void

removeEventListener()?​

optional removeEventListener(event, listener): void

Defined in: websocket/src/types.ts:79

Parameters​

event​

"message"

listener​

(event) => void

Returns​

void

removeListener()?​

optional removeListener(event, listener): void

Defined in: websocket/src/types.ts:82

Parameters​

event​

"message"

listener​

(data) => void

Returns​

void

send()​

send(data): void

Defined in: websocket/src/types.ts:70

Sends one text frame.

Parameters​

data​

string

Serialized payload.

Returns​

void