/ws.ts | ayonli_jsext@v0.9.72

A JavaScript extension package for building strong and modern applications.

Latest

archive array augment bundle bytes class cli collections dialog error esm examples external fastly filetype fs hash http json math module number object parallel path promise reader string uint8array workerd ws

index.ts (default module)

parallel

run

AbstractConstructor

AsyncFunction

AsyncFunctionConstructor

AsyncGeneratorFunction

tar

run

EOL

md5

avg

FunctionPropertyNames

sep

cwd

addUnhandledRejectionListener

env

AsyncFunctionConstructor

AsyncGeneratorFunction

import * as ayonliJsext from "https://deno.land/x/ayonli_jsext@v0.9.72/ws.ts";

This module provides a unified WebSocket server interface for Node.js, Deno, Bun and Cloudflare Workers. This module is based on the EventTarget interface and conforms the web standard.

IMPORTANT: The WebSocketConnection interface is an abstraction of the WebSocket on the server side, it's design is not consistent with the WebSocket API in the browser. For example, when receiving binary data, the data property is always a Uint8Array object, which is different from the Blob object (or ArrayBuffer) in the browser. In the future, we may provide a more consistent API, be aware of this when using this module.

Classes

c WebSocketConnection	This class represents a WebSocket connection on the server side. Normally we don't create instances of this class directly, but rather use the WebSocketServer to handle WebSocket connections, which will create the instance for us.
c WebSocketServer	A unified WebSocket server interface for Node.js, Deno, Bun and Cloudflare Workers.

Interfaces

ServerOptions

Options for the WebSocketServer constructor.

Type Aliases

T WebSocketHandler	WebSocket handler function for the WebSocketServer constructor.
T WebSocketLike