Class ClientWrapper

Hierarchy

  • ClientWrapper

constructor

Primary Controls

send

General Properties

alive customData identifier

Internal Data

socket

constructor

  • Parameters

    • identifier: string

      UUID generated by the Server.

      Category

      General Properties

    • socket: SocketLike

      The WebSocket used to communicate with the the client

      Category

      Internal Data

    • customData: Record<string, Serializable> = {}

      Object for holding custom data about the client.

      Category

      General Properties

    Returns ClientWrapper

Primary Controls

send

  • Sends a SocketRequest to the client socket.

    Parameters

    • msg: SocketRequest

      The SocketRequest to send. Will be stringified on the way out.

    Returns void

General Properties

alive

alive: boolean = true

true if actively connected, false if the connection is broken.

customData

customData: Record<string, Serializable> = {}

Object for holding custom data about the client.

Readonly identifier

identifier: string

UUID generated by the Server.

Internal Data

Readonly socket

socket: SocketLike

The WebSocket used to communicate with the the client

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc