Skip to main content

Class: AsyncWebSocket

Defined in: src/websocket/websocket.ts:54

AsyncWebSocket - Async WebSocket client

Accessors​

closed​

Get Signature​

get closed(): boolean

Defined in: src/websocket/websocket.ts:148

Check if closed

Returns​

boolean

closeEvent​

Get Signature​

get closeEvent(): WebSocketCloseEvent | null

Defined in: src/websocket/websocket.ts:155

Get close event details

Returns​

WebSocketCloseEvent | null

connected​

Get Signature​

get connected(): boolean

Defined in: src/websocket/websocket.ts:141

Check if connected

Returns​

boolean

url​

Get Signature​

get url(): string

Defined in: src/websocket/websocket.ts:134

Get the WebSocket URL

Returns​

string

Methods​

[asyncIterator]()​

[asyncIterator](): AsyncIterableIterator<WebSocketMessage>

Defined in: src/websocket/websocket.ts:439

Async iterator for receiving messages

Returns​

AsyncIterableIterator<WebSocketMessage>

close()​

close(code?, reason?): Promise<void>

Defined in: src/websocket/websocket.ts:407

Close the WebSocket connection

Parameters​

code?​

number = 1000

reason?​

string = ""

Returns​

Promise<void>

ping()​

ping(data?): Promise<void>

Defined in: src/websocket/websocket.ts:388

Send ping frame

Parameters​

data?​

string | Buffer

Returns​

Promise<void>

recv()​

recv(timeout?): Promise<WebSocketMessage>

Defined in: src/websocket/websocket.ts:247

Receive a message with polling

Parameters​

timeout?​

number

Returns​

Promise<WebSocketMessage>

recvJson()​

recvJson<T>(timeout?): Promise<T>

Defined in: src/websocket/websocket.ts:327

Receive and parse as JSON

Type Parameters​

T​

T = unknown

Parameters​

timeout?​

number

Returns​

Promise<T>

recvStr()​

recvStr(timeout?): Promise<string>

Defined in: src/websocket/websocket.ts:319

Receive a text message

Parameters​

timeout?​

number

Returns​

Promise<string>

send()​

send(data): Promise<void>

Defined in: src/websocket/websocket.ts:357

Send binary data

Parameters​

data​

Buffer | Uint8Array

Returns​

Promise<void>

sendBinary()​

sendBinary(data): Promise<void>

Defined in: src/websocket/websocket.ts:373

Send binary data

Parameters​

data​

Buffer | Uint8Array

Returns​

Promise<void>

sendJson()​

sendJson(data): Promise<void>

Defined in: src/websocket/websocket.ts:380

Send JSON message

Parameters​

data​

unknown

Returns​

Promise<void>

sendStr()​

sendStr(text): Promise<void>

Defined in: src/websocket/websocket.ts:365

Send text message

Parameters​

text​

string

Returns​

Promise<void>

connect()​

static connect(url, options?): Promise<AsyncWebSocket>

Defined in: src/websocket/websocket.ts:106

Connect to a WebSocket server

Parameters​

url​

string

options?​

WebSocketOptions = {}

Returns​

Promise<AsyncWebSocket>