Class ScreepsRateLimitTracker

Tracks rate limit status for all HTTP API endpoints.

Do not instantiate this class. Instead, use the instance from ScreepsHttpClient.rateLimits.

Index

Guides

HTTP API Rate Limits

Other

constructor GET global POST describe find update

Other

constructor

new ScreepsRateLimitTracker(): ScreepsRateLimitTracker
Returns ScreepsRateLimitTracker
- Defined in src/ScreepsRateLimitTracker.ts:66

`Readonly`GET

GET: { [path: string]: RateLimit }

`Readonly`global

global: RateLimit

`Readonly`POST

POST: { [path: string]: RateLimit }

describe

describe(method: ScreepsHttpMethod, path: string, limit: RateLimit): string
Parameters
- method: ScreepsHttpMethod
- path: string
- limit: RateLimit
Returns string
- Defined in src/ScreepsRateLimitTracker.ts:104

find

find(method: ScreepsHttpMethod, path: string): RateLimit
Parameters
- method: ScreepsHttpMethod
- path: string
Returns RateLimit
- Defined in src/ScreepsRateLimitTracker.ts:89

update

update(
    method: ScreepsHttpMethod,
    path: string,
    latest: RateLimitUpdate,
): RateLimit
Parameters
- method: ScreepsHttpMethod
- path: string
- latest: RateLimitUpdate
Returns RateLimit
- Defined in src/ScreepsRateLimitTracker.ts:93