Interface PlayerRequestOptions
allowCache?: boolean;
apiKey?: string;
cacheFor?: number;
forceCaseMatch?: boolean;
forceUUIDLookup?: boolean;
ignoreVersion?: boolean;
multipleChoicesSelector?: ((v, i, a) => boolean | Promise<boolean>);
player: string;
priority?: boolean;
retries?: number;
timeout?: number;
}
Hierarchy
- SelectingRequestOptions<PlayerMultipleChoice>
- PlayerRequestOptions
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 force
Default
false
Deprecated
As of v3.1.0, this option has no effect.
Optional forceUUIDLookup
Whether to force a UUID lookup before the player request. This can help reduce some errors caused by name changes. Ignored if player is a UUID
Default
false
Deprecated
As of v3.1.0, this option has no effect.
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: PlayerMultipleChoice
The current choice
i: number
The index of the current choice
a: PlayerMultipleChoice[]
The array of all choices
Returns boolean | Promise<boolean>
True, if the given choice should be selected
player
A player UUID or name; case-insensitive
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 timeout
The amount of milliseconds a until the request should be rejected
The options for a player API request