Interface ConfigOptions
interface ConfigOptions {
allowCacheByDefault?: boolean;
apiKeys?: ApiKey[];
defaultCacheTimes?: CacheTimeOptions;
defaultRetries?: number;
defaultTimeout?: number;
maxQueueLength?: number;
throwOnRatelimitError?: boolean;
}
allowCacheByDefault?: boolean;
apiKeys?: ApiKey[];
defaultCacheTimes?: CacheTimeOptions;
defaultRetries?: number;
defaultTimeout?: number;
maxQueueLength?: number;
throwOnRatelimitError?: boolean;
}
Properties
Optional allow
allow
Whether to allow requests to use the cache or currently ongoing requests.
This is overridden by RequestOptions.allowCache.
Optional api
The API keys to use
Optional default
The amount of milliseconds to cache requests of these routes for
Optional default
default
The amount of times a request should be retried on error
This is overridden by RequestOptions.retries.
Optional default
default
The amount of milliseconds a until a request should be rejected
This is overridden by RequestOptions.timeout.
Be aware that each retry has it's own timeout, meaning 30,000 ms of timeout may lead to a 90,000 ms wait until a request is rejected on 2 retries.
Optional max
max
How many request should be allowed to be queued before the wrapper rejects new requests with an error
Optional throw
throw
Whether exceeding the ratelimit should throw an error, or whether the request should be retried after the ratelimit reset
The options to set the config to