Interface RatelimitChannel

A Ratelimit channel has a private ratelimit that is unaffected by other calls to the API

Only calls using the apiKey of the channel affect the ratelimit.
If no API keys are set in the config, only one channel exists with the apiKey being set to null.
interface RatelimitChannel {
    apiKey: string;
    interval: number;
    queued: number;
    remaining: number;
    reset: number;
    total: number;
}

Properties

apiKey interval queued remaining reset total

Properties

apiKey

apiKey: string

The API key being used with this channel

interval

interval: number

The amount of milliseconds after which this channels' remaining requests are reset to the limit

queued

queued: number

The amount of requests currently queued to be processed using this key

remaining

remaining: number

Requests remaining on this channel

reset

reset: number

The amount of milliseconds remaining until this channels' remaining requests are reset to the limit

total

total: number

The limit the channel gets reset to upon reset

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc