Type alias WebSocketOptions

WebSocketOptions: {
    autoConnectOnErr?: boolean;
    headers?: Record<string, string>;
    proxyURL?: string;
    reconnectAttemptLimit?: number;
    replayMissedEvents?: boolean;
    token: string;
    version?: 1;
}

Type declaration

  • Optional autoConnectOnErr?: boolean

    Whether to try to re-establish connection on error

  • Optional headers?: Record<string, string>

    The additional headers that will be added to WebSocket request upon initial connection.

  • Optional proxyURL?: string

    The base url that the websocket will connect to.

  • Optional reconnectAttemptLimit?: number

    Limit of how many times a reconnection should be attempted

  • Optional replayMissedEvents?: boolean

    Whether the manager should request missed events on reconnect

  • token: string

    The bot's token.

  • Optional version?: 1

    The version of the websocket to connect to.

Settings

Member Visibility

Theme

Generated using TypeDoc