WebSocketServer

A WebSocket server that listens for incoming connections on a TCP port.

Uses the Web EventTarget API and dispatches CustomEvent instances.

Example

import { WebSocketServer } from '@nx.js/ws';

const wss = new WebSocketServer({ port: 8080 });

wss.addEventListener('connection', (e) => {
  const { socket, request } = e.detail;
  console.log('Client connected from', request.url);

  socket.addEventListener('message', (ev) => {
    console.log('Received:', ev.data);
    socket.send(`Echo: ${ev.data}`);
  });

  socket.addEventListener('close', () => {
    console.log('Client disconnected');
  });
});

Constructors

new WebSocketServer()

new WebSocketServer(opts): WebSocketServer

Parameters

Parameter	Type
`opts`	`WebSocketServerOptions`

Properties

Property	Modifier	Type
`clients`	`readonly`	`Set`<`WebSocket`>

Methods

addEventListener()

addEventListener(type, callback, options?): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference