Type alias RestOptions

RestOptions: {
    headers?: Record<string, string>;
    maxRatelimitRetryLimit?: number;
    proxyURL?: string;
    restOffset?: number;
    token: string;
    version?: 1;
}

Type declaration

  • Optional headers?: Record<string, string>

    The additional headers that will be added to each request done by RestManager.

  • Optional maxRatelimitRetryLimit?: number

    How many times to retry a request that's been ratelimited before failing

  • Optional proxyURL?: string

    The base url of the API you want to send requests to. By default, this will send it to guilded's rest API. This is meant for big bot developers who want to use a proxy rest system.

  • Optional restOffset?: number

    How long to delay each request by.

  • token: string

    The bot token to be used for making requests.

  • Optional version?: 1

    The version of the API to be used for making requests. By default, this will use the latest version that the library supports.

Settings

Member Visibility

Theme

Generated using TypeDoc