ws-asyncapi API / client / WebSocketLike
Interface: WebSocketLike
Defined in: .api-entries/client/index.d.ts:82
Minimal WebSocket surface the client drives — enough to plug in a custom transport (SSR/Node, React Native, or an in-memory pipe for tests) via the socket option. The browser WebSocket satisfies it.
Properties
binaryType?
optionalbinaryType?:string
Defined in: .api-entries/client/index.d.ts:83
readyState
readonlyreadyState:number
Defined in: .api-entries/client/index.d.ts:85
0 CONNECTING · 1 OPEN · 2 CLOSING · 3 CLOSED
onopen
onopen: (
event) =>void
Defined in: .api-entries/client/index.d.ts:88
Parameters
event
unknown
Returns
void
onmessage
onmessage: (
event) =>void
Defined in: .api-entries/client/index.d.ts:89
Parameters
event
data
unknown
Returns
void
onerror
onerror: (
event) =>void
Defined in: .api-entries/client/index.d.ts:92
Parameters
event
unknown
Returns
void
onclose
onclose: (
event) =>void
Defined in: .api-entries/client/index.d.ts:93
Parameters
event
unknown
Returns
void
Methods
send()
send(
data):void
Defined in: .api-entries/client/index.d.ts:86
Parameters
data
string | Uint8Array<ArrayBufferLike>
Returns
void
close()
close(
code?,reason?):void
Defined in: .api-entries/client/index.d.ts:87
Parameters
code?
number
reason?
string
Returns
void