Interface Config
interface Config {
allowCacheByDefault: boolean;
apiKeys: ApiKey[];
defaultRetries: number;
defaultTimeout: number;
maxQueueLength: number;
routes: Routes;
throwOnRatelimitError: boolean;
}
allowCacheByDefault: boolean;
apiKeys: ApiKey[];
defaultRetries: number;
defaultTimeout: number;
maxQueueLength: number;
routes: Routes;
throwOnRatelimitError: boolean;
}
Properties
allow
allow
Whether to allow requests to use the cache or currently ongoing requests
This is overridden by RequestOptions.allowCache.
Default
true
api
The API keys being used
default
default
The amount of times a request should be retried on error
This is overridden by RequestOptions.retries.
Default
3
default
default
The amount of milliseconds a until a request should be rejected
This is overridden by RequestOptions.timeout.
Default
30000
max
max
The maximum amount of queued requests before new requests are rejected with an error
Default
50
routes
Information on all supported routes
throw
throw
Whether exceeding the ratelimit should throw an error, or whether the request should be retried after the ratelimit reset
Default
false
The configuration of the library