Hierarchy
- ConfigOptions
Index
Properties
Optional allow
Whether to allow requests to use the cache
This is overridden by RequestOptions.allowCache.
Optional allow
Whether to allow request stacking in raw API calls
This is overridden by RawRequestOptions.allowStacking.
Optional api
The API keys to use
Optional default
The amount of milliseconds to cache requests of these routes for
Optional default
The amount of times a request should be retried on error
This is overridden by RequestOptions.retries.
Optional 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
How many request should be allowed to be queued before the wrapper rejects new requests with an error
Optional reuse
Whether to reuse JSON objects returned by the fetchRaw() method instead of regenerating them every time they are drawn from cache;
Disabling this hurts performance, but hardens the code against bugs due to downstream code modifying API responses in the cache.
Optional 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