net/websockets

Documentation

• source: net/websockets.ts

Overview

Classes

Websockets

createWebsocket()

Creates a new WebSocket client connection to a specified URI, managed by a handler script.

static createWebsocket(uri: string, handler: string): WebsocketClient;

Parameter	Type	Description
uri	string	The target WebSocket URI (e.g., 'ws://example.com/socket').
handler	string	The identifier or path of the script handling the WebSocket events.

Returns

• Type: WebsocketClient
• Description: A wrapper object for the new WebSocket session.

getClients()

Retrieves a list of all active WebSocket clients.

static getClients(): void;

Returns

• Type: void
• Description: An array of objects detailing the URI and handler of each client.

getClient()

Retrieves a specific WebSocket client wrapper by its session ID.

static getClient(id: string): WebsocketClient;

Parameter	Type	Description
id	string	The session ID of the client.

Returns

• Type: WebsocketClient
• Description: The client wrapper or undefined if not found.

getClientByHandler()

Retrieves a specific WebSocket client wrapper by its handler identifier.

static getClientByHandler(handler: string): WebsocketClient;

Parameter	Type	Description
handler	string	The handler identifier associated with the client.

Returns

• Type: WebsocketClient
• Description: The client wrapper or undefined if not found.

getMessage()

Retrieves the message payload from the current context, typically used inside an 'onmessage' handler.

static getMessage(): any;

Returns

• Type: any
• Description: The message content.

getError()

Retrieves error details from the current context, typically used inside an 'onerror' handler.

static getError(): any;

Returns

• Type: any
• Description: The error object or string.

getMethod()

Retrieves the event method name that triggered the current script execution (e.g., "onopen", "onmessage").

static getMethod(): string;

Returns

• Type: string
• Description: The name of the event method.

isOnOpen()

Checks if the current event context is 'onopen'.

static isOnOpen(): boolean;

Returns

• Type: boolean
• Description: True if the method is 'onopen'.

isOnMessage()

Checks if the current event context is 'onmessage'.

static isOnMessage(): boolean;

Returns

• Type: boolean
• Description: True if the method is 'onmessage'.

isOnError()

Checks if the current event context is 'onerror'.

static isOnError(): boolean;

Returns

• Type: boolean
• Description: True if the method is 'onerror'.

isOnClose()

Checks if the current event context is 'onclose'.

static isOnClose(): boolean;

Returns

• Type: boolean
• Description: True if the method is 'onclose'.