interface WebSocketConnection

A server-side WebSocket connection accepted by a WebSocketServer.

Index

Properties

• bufferedAmount
• protocol

Methods

• close(code, reason)
• on(type, listener)
• send(value)

bufferedAmount number read-only

The number of queued outbound bytes.

close(code, reason)

Closes the connection.

close(code?: number, reason?: string): void;

on(type, listener)

Registers an event listener (message, close, error, drain).

on(type: string, listener: (...args: any[]) => void): this;

protocol string read-only

The negotiated subprotocol, or "".

send(value)

Sends data. See WebSocket.send().

send(
  value: string | buffer.IOBuffer | ArrayBuffer | ArrayBufferView,
): boolean;