Library referenceClasses
KrunkerDeveloperApi
the documented developer api; one key is one rate limit window, so keep one instance per key
Extended by
Constructors
Constructor
new KrunkerDeveloperApi(options?): KrunkerDeveloperApi;Parameters
| Parameter | Type |
|---|---|
options? | ClientOptions |
Returns
KrunkerDeveloperApi
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
clan | readonly | ClanApi | - |
events | readonly | EventsApi | needs an events scope on the key |
kpd | readonly | KpdApi | needs the kpd scope on the key |
leaderboard | readonly | LeaderboardApi | - |
map | readonly | MapApi | - |
market | readonly | MarketApi | - |
match | readonly | MatchApi | - |
mods | readonly | ModsApi | - |
player | readonly | PlayerApi | - |
skins | readonly | SkinsApi | - |
Accessors
configured
Get Signature
get configured(): boolean;false without an api key, every call throws KrunkerConfigError then
Returns
boolean
Methods
rateLimit()
rateLimit(): RateLimitState;what the last replies said about the key's window, for a health or admin view