Class ScreepsRateLimitTracker

Tracks rate limit status for all HTTP API endpoints.

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

Index

Constructors

Properties

GET global POST

Methods

describe find update

Constructors

constructor

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

Properties

`Readonly`GET

GET: { [path: string]: RateLimit }

`Readonly`global

global: RateLimit

`Readonly`POST

POST: { [path: string]: RateLimit }

Methods

describe

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

find

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

update

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