PlayerRequestOptions | gavel-gateway-js

The options for a player API request

Index

allowCache?: boolean

Whether to allow this request to pull from cache if available

apiKey?: string

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.

cacheFor?: number

The amount of time the request should be cached for

This only applies to fetchRaw.

ignoreVersion?: boolean

Whether to ignore version errors

You can use this to resolve temporary conflicts while the library awaits being updated. Otherwise it should stay enabled.

player: string

A player UUID or name

priority?: boolean

Whether this request should be put to the front of the queue, executing before any non-priority requests are handled

retries?: number

The amount of times to retry the request on error

timeout?: number

The amount of milliseconds a until the request should be rejected