revbot.js
    Preparing search index...

    Interface clientOptions

    Represents the options for configuring the client.

    interface clientOptions {
        fetchMembers?: boolean;
        ignoreBots?: boolean;
        ignoreEvents?: string[];
        isBot?: boolean;
        MessageCache?: { maxSize?: number };
        rest?: {
            instanceCDNURL?: string;
            instanceURL?: string;
            retries?: number;
            timeout?: number;
        };
        ws?: {
            heartbeatInterval?: number;
            instanceURL?: string;
            reconnect?: boolean;
        };
    }
    Index

    Properties

    fetchMembers? ignoreBots? ignoreEvents? isBot? MessageCache? rest? ws?

    Properties

    fetchMembers?: boolean

    Whether to fetch all members of a server.

    ignoreBots?: boolean

    Whether to ignore bot messages.

    ignoreEvents?: string[]

    events for the client to ignore.

    isBot?: boolean

    wether to use X-Session-Token or X-Bot-Token

    MessageCache?: { maxSize?: number }

    Type declaration

    • OptionalmaxSize?: number

      The maximum size of the cache.

    rest?: {
        instanceCDNURL?: string;
        instanceURL?: string;
        retries?: number;
        timeout?: number;
    }

    Configuration for REST API requests.

    Type declaration

    • OptionalinstanceCDNURL?: string

      URL for revolt CDN instance without trailing slash

    • OptionalinstanceURL?: string

      URL for revolt API instance without trailing slash

    • Optionalretries?: number

      The number of retries for failed REST requests.

    • Optionaltimeout?: number

      The timeout for REST requests in milliseconds.

    ws?: { heartbeatInterval?: number; instanceURL?: string; reconnect?: boolean }

    Configuration for WebSocket connections.

    Type declaration

    • OptionalheartbeatInterval?: number

      The interval for sending heartbeats in milliseconds.

    • OptionalinstanceURL?: string

      URL for revolt WebSocket instance without trailing slash

    • Optionalreconnect?: boolean

      Whether to automatically reconnect on disconnection.

    Settings

    Member Visibility

    On This Page

    Properties