Class WebSocketClient`Beta`

An active WebSocket client.

Index

Properties

afterEvents isOpen

Methods

Properties

`Readonly` `Beta`afterEvents

afterEvents: WebSocketClientAfterEvents

Remarks

Contains a set of events related to this WebSocket client.

`Readonly` `Beta`isOpen

isOpen: boolean

Remarks

Set to true if the socket is current connected to the server.

Methods

close

close(): void
Beta
Returns void
Remarks
Closes the connection with the server.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

WebSocketNotConnectedError
- Defined in tmp/package/index.d.ts:888

send

send(payload: string): void
Beta
Parameters
- payload: string
  The payload that will be included in the network packet.
Returns void
Remarks
Sends the provided payload to the server.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

RequestBodyTooLargeError

WebSocketNotConnectedError
- Defined in tmp/package/index.d.ts:903