Type Alias ClientOptions

ClientOptions: Partial<EventClientOptions> & {
    autoReconnect: boolean;
    baseURL: string;
    eagerFetching: boolean;
    messageRewrites: boolean;
    partials: boolean;
    syncUnreads: boolean;
    channelExclusiveMuted(channel: Channel): boolean;
    channelIsMuted(channel: Channel): boolean;
    retryDelayFunction(retryCount: number): number;
}

Client options object

Type declaration

  • autoReconnect: boolean

    Whether to reconnect when disconnected

    Default

    true
  • baseURL: string

    Base URL of the API server

  • eagerFetching: boolean

    Whether to eagerly fetch users and members for incoming events

    Default

    true

    Deprecated

  • messageRewrites: boolean

    Whether to rewrite sent messages that include identifiers such as

    Silent

    Default

    true
  • partials: boolean

    Whether to allow partial objects to emit from events

    Default

    false
  • syncUnreads: boolean

    Whether to automatically sync unreads information

    Default

    false
  • channelExclusiveMuted:function
    • channelExclusiveMuted(channel: Channel): boolean

      Check whether a channel is exclusively muted (irrespective of server)

      Parameters

      Returns boolean

      Whether it is exclusively muted

      Default

      false
  • channelIsMuted:function
    • channelIsMuted(channel: Channel): boolean

      Check whether a channel is muted

      Parameters

      Returns boolean

      Whether it is muted or through inheritance

      Default

      false
  • retryDelayFunction:function
    • retryDelayFunction(retryCount: number): number

      Retry delay function

      Parameters

      • retryCount: number

        Count

      Returns number

      Delay in seconds

      Default

      (2^x-1) ±20%