Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlayerLeaderboardRequestOptions

The options for a player leaderboard API request

Hierarchy

Index

Properties

Properties

Optional allowCache

allowCache?: boolean

Whether to allow this request to pull from cache if available

Optional apiKey

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.

Optional cacheFor

cacheFor?: number

The amount of time the request should be cached for

This only applies to fetchRaw.
default

30000

Optional ignoreVersion

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.
default

false

Optional priority

priority?: boolean

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

default

false

Optional retries

retries?: number

The amount of times to retry the request on error

Optional scope

scope?: PlayerLeaderboardScope

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

default

"TOTAL"

Optional timeout

timeout?: number

The amount of milliseconds a until the request should be rejected

Optional type

type?: "PVP" | "COMBAT" | "PROFESSION" | "COMBINED" | "MINING" | "WOODCUTTING" | "FARMING" | "FISHING" | "SCRIBING" | "COOKING" | "ALCHEMISM" | "WOODWORKING" | "WEAPONSMITHING" | "TAILORING" | "ARMORING" | "JEWELING"

The type of level or levels to rank

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

"COMBAT"

Generated using TypeDoc