Class WebsocketManager

The Websocket manager for the Guilded API.

Example

new WebsocketManager({ version: 1, token: 'token' });

Hierarchy

  • EventEmitter
    • WebsocketManager

Constructors

constructor

Properties

lastMessageId? options ping? pingedAt? proxyUrl? readyAt? reconnects socket? token? version?

Accessors

isReady pingedTimestamp readyTimestamp uptime url

Methods

connect disconnect

Constructors

constructor

Properties

Optional lastMessageId

lastMessageId?: string

The last message ID.

Readonly options

options: WebsocketOptions

Optional ping

ping?: number

The ping of the websocket connection.

Optional pingedAt

pingedAt?: Date

The date the websocket was pinged.

Optional Readonly proxyUrl

proxyUrl?: string

The proxy URL of the Websocket API.

Optional readyAt

readyAt?: Date

The date the websocket is ready.

reconnects

reconnects: number

The anount of times the websocket has been reconnected.

Optional socket

socket?: WebSocket

The websocket.

Optional token

token?: string

The auth token for the websocket.

Optional Readonly version

version?: number

The version of the Websocket API.

Accessors

isReady

  • get isReady(): boolean

  • Whether the websocket is ready.

    Returns boolean

pingedTimestamp

  • get pingedTimestamp(): undefined | number

  • The timestamp the websocket was pinged.

    Returns undefined | number

readyTimestamp

  • get readyTimestamp(): undefined | number

  • The timestamp of when the websocket is ready.

    Returns undefined | number

uptime

  • get uptime(): undefined | number

  • How long the websocket has been connected.

    Returns undefined | number

url

  • get url(): string

  • The URL of the Websocket.

    Returns string

Methods

connect

  • Connect to the Websocket API.

    Returns

    The Websocket manager.

    Example

    ws.connect('token');

    Parameters

    • Optional token: string

      The auth token.

    Returns WebsocketManager

disconnect

  • Disconnect from the Websocket API.

    Returns

    The websocket manager.

    Example

    ws.disconnect();

    Returns WebsocketManager

Settings

Member Visibility

Theme