Interface RawRequestOptions
allowCache?: boolean;
apiKey?: string;
cacheFor?: number;
ignoreVersion?: boolean;
interpret?: boolean;
priority?: boolean;
retries?: number;
reuseJson: boolean;
route: `https://api.wynncraft.com/${string}`;
routeVersion?: null | string | number;
timeout?: number;
}
Hierarchy
- RequestOptions
- RawRequestOptions
Properties
Optional allow
Whether to allow this request to use the cache or ongoing requests if available
Requests using cache or other requests do not count towards the ratelimit and return a lot faster.
Optional api
The API key to use in this request
The key has to be registered in the config.
If this is not given, the registered key with the most free requests will be selected.
Optional cache
The amount of time the request should be cached for, overwrites the defaults specified in the config
Optional ignore
Whether to ignore version errors
You can use this to resolve temporary conflicts while the library awaits being updated. Otherwise it should stay enabled.
Default
false
Optional interpret
Whether errors or profiles not being found should be
filtered out and throw errors/return null
Default
true
Optional priority
Whether this request should be put to the front of the queue, executing before any non-priority requests are handled
Default
false
Optional retries
The amount of times to retry the request on error
reuse
Whether to reuse objects returned by this in other calls to fetchRaw(). If you want to modify the return value, you should set this to false.
Disabling this hurts performance, but hardens the code against bugs due to downstream code modifying cached objects.
Default
true
route
The API route to request
Optional route
The expected version property, responses with another version will throw an error. This has no effect on v3
Optional timeout
The amount of milliseconds a until the request should be rejected
The options for a raw API request