Interface GuildRequestOptions
allowCache?: boolean;
apiKey?: string;
cacheFor?: number;
fetchAdditionalStats?: boolean;
guild?: string;
ignoreVersion?: boolean;
multipleChoicesSelector?: ((v, i, a) => boolean | Promise<boolean>);
priority?: boolean;
retries?: number;
tag?: string;
timeout?: number;
uuid?: string;
}
Hierarchy
- SelectingRequestOptions<GuildMultipleChoice>
- GuildRequestOptions
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 fetch
Whether to display more precise and additional information
This may cause extra API requests.
Default
false
Optional guild
The name of the guild, case insensitive
Either this, uuid or tag has to be defined. This is overridden by uuid
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 multiple
Type declaration
- (v, i, a): boolean | Promise<boolean>
A function that will be executed with each of the choices as a parameter. It may return a Promise of a boolean. In that case, the selector will be executed for all values simultaneously. And the passing element with the lowest index will be selected. If the selector returns false for all choices, the error is thrown regardless
Parameters
v: GuildMultipleChoice
The current choice
i: number
The index of the current choice
a: GuildMultipleChoice[]
The array of all choices
Returns boolean | Promise<boolean>
True, if the given choice should be selected
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
Optional tag
The tag of the guild, case sensitive
Either this, uuid or guild has to be defined. This is overridden by guild and uuid
Optional timeout
The amount of milliseconds a until the request should be rejected
Optional uuid
The UUID of the guild
Either this, name or tag has to be defined.
The options for a guild API request