API Reference
Classes
| Class | Description |
|---|---|
| KeyvCache | uses keyv's in-memory adapter by default. pass a persistent adapter such as @keyv/redis for shared or persistent caching. |
| NetworkAPIError | base error for failures raised by a network stats API client |
| NetworkAuthExhaustedError | indicates that all configured API credentials have been exhausted. |
| NetworkBadRequestError | indicates a malformed request. |
| NetworkClient | shared foundation for per-network clients |
| NetworkHTTPError | a generic HTTP failure (405/500/502/503/504/etc.) that isn't one of the more specific cases below. |
| NetworkRateLimitError | indicates that the upstream API is rate-limiting requests (HTTP 429). back off! |
| NetworkValidationError | indicates that the response does not conform to the expected schema. |
| NullCache | no-op cache for callers who want caching disabled entirely |
| PikaNetworkClient | typed, runtime-validated client |
| TokenBucketRateLimiter | - |
Interfaces
| Interface | Description |
|---|---|
| BatchOptions | - |
| GetLeaderboardParams | - |
| GetProfileStatsParams | - |
| GetTotalsParams | - |
| LeaderboardEntry | - |
| LeaderboardPage | - |
| NetworkCache | caches network responses to avoid redundant requests. uses keyv's in-memory adapter by default. pass a persistent adapter for shared or durable caching. |
| NetworkClientOptions | - |
| PikaNetworkClientOptions | - |
| ProfileStat | - |
| RateLimiterOptions | proactive token-bucket rate limiter for APIs that provide no RateLimit-* headers |
| RequestConfig | - |
Type Aliases
| Type Alias | Description |
|---|---|
| BatchResult | - |
| ClanMember | - |
| PikaNetworkClanResponse | - |
| PikaNetworkGamemode | - |
| PikaNetworkInterval | - |
| PikaNetworkLeaderboardResponse | - |
| PikaNetworkMode | - |
| PikaNetworkProfileDonorRank | - |
| PikaNetworkProfileFriend | - |
| PikaNetworkProfileResponse | - |
| PikaNetworkRankScope | - |
| PikaNetworkStat | - |
| PikaNetworkStatKey | - |
| PikaNetworkTotalsResponse | - |
| ProfileStatAccessor | provides direct access to profile stats through the StatKey hierarchy. stats that were not fetched or have no recorded value resolve to null. |
| ProfileStats | profile stats returned as a normal ProfileStat[] with an additional non-enumerable StatKey accessor for direct, autocomplete-friendly lookup. |
Variables
| Variable | Description |
|---|---|
| Gamemode | ergonomic alias |
| Interval | - |
| Mode | - |
| PikaNetworkClanResponseSchema | GET /clans/ |
| PikaNetworkDefaultBaseUrl | shared PikaNetwork client defaults |
| PikaNetworkDefaultRateLimit | REVIEW: derived from live API load testing (approximated). override via rateLimit when using different request constraints. |
| PikaNetworkGamemodes | - |
| PikaNetworkIntervals | - |
| PikaNetworkLeaderboardResponseSchema | - |
| PikaNetworkModes | valid mode values per gamemode |
| PikaNetworkProfileDonorRankSchema | - |
| PikaNetworkProfileResponseSchema | GET /profile/ |
| PikaNetworkProfileStatsResponseSchema | GET /profile/{username}/leaderboard |
| PikaNetworkRecapResponseSchema | GET /recaps/ |
| PikaNetworkRequiredMode | - |
| PikaNetworkStatAliases | querying the alias returns the same data as the canonical stat |
| PikaNetworkStats | - |
| PikaNetworkTotalsResponseSchema | - |
| Stat | - |
| StatKey | - |
| YearlyCapableGamemodes | interval=yearly doesn't work outside these gamemodes. enforced at the type and request level. |
Functions
| Function | Description |
|---|---|
| getTopRank | Returns the highest donor or staff rank in the requested scope. |
| setLogLevel | - |
| toLeaderboardPage | - |
| withStatKeyAccessor | wraps a raw ProfileStat[] with the .StatKey.<Gamemode>.<Stat> accessor indexed via a Map for O(1) reads without mutating the caller's input array. |