PlayerLeaderboardRequestOptions | gavel-gateway-js

The options for a player leaderboard 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, overwrites the defaults specified in the config

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.

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

The scope of the leaderboard; TOTAL means all classes, SOLO means single class

timeout?: number

The amount of milliseconds a until the request should be rejected

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.

The type of level or levels to rank

Make sure the type is a type in the selected scope.