Interface WebSocketServer

interface WebSocketServer {
    clients: Set<WebSocketClient>;
    name: string;
    off: {
        (event, cb): this;
        (event, cb): this;
        (event, cb): this;
        (event, cb): this;
        (event, listener): this;
    } & ((event, listener) => void);
    on: {
        (event, cb): this;
        (event, cb): this;
        (event, cb): this;
        (event, cb): this;
        (event, listener): this;
    } & (<T>(event, listener) => void);
    close(): Promise<void>;
    listen(): void;
    send(payload): void;
    send<T>(event, payload?): void;
}

Hierarchy (view full)

Properties

clients name off on

Methods

close listen send

Properties

clients

clients: Set<WebSocketClient>

Get all connected clients.

name

name: string

Unique channel name

off

off: {
    (event, cb): this;
    (event, cb): this;
    (event, cb): this;
    (event, cb): this;
    (event, listener): this;
} & ((event, listener) => void)

Unregister event listener.

Type declaration

    • (event, cb): this

    • Parameters

      Returns this

    • (event, cb): this

    • Parameters

      • event: "error"
      • cb: ((this, error) => void)

      Returns this

    • (event, cb): this

    • Parameters

      • event: "headers"
      • cb: ((this, headers, request) => void)

      Returns this

    • (event, cb): this

    • Parameters

      • event: "close" | "listening"
      • cb: ((this) => void)

      Returns this

    • (event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((this, ...args) => void)
          • (this, ...args): void

          • Parameters

            Returns void

      Returns this

Type declaration

    • (event, listener): void

    • Parameters

      Returns void

on

on: {
    (event, cb): this;
    (event, cb): this;
    (event, cb): this;
    (event, cb): this;
    (event, listener): this;
} & (<T>(event, listener) => void)

Handle custom event emitted by import.meta.hot.send

Type declaration

    • (event, cb): this

    • Parameters

      Returns this

    • (event, cb): this

    • Parameters

      • event: "error"
      • cb: ((this, error) => void)

      Returns this

    • (event, cb): this

    • Parameters

      • event: "headers"
      • cb: ((this, headers, request) => void)

      Returns this

    • (event, cb): this

    • Parameters

      • event: "close" | "listening"
      • cb: ((this) => void)

      Returns this

    • (event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((this, ...args) => void)
          • (this, ...args): void

          • Parameters

            Returns void

      Returns this

Type declaration

Methods

close

  • close(): Promise<void>

  • Disconnect all clients and terminate the server.

    Returns Promise<void>

listen

  • listen(): void

  • Listen on port and host

    Returns void

send

  • send(payload): void

  • Broadcast events to all clients

    Parameters

    Returns void

  • send<T>(event, payload?): void

  • Send custom event

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

clientsnameoffoncloselistensend