Interface RateLimitEvent

Payload of ScreepsHttpClient.RATE_LIMIT events.

interface RateLimitEvent {
    limit: number;
    method: ScreepsHttpMethod;
    params: unknown;
    path: string;
    period: RateLimitPeriod;
    remaining: number;
    reset: number;
    retriesAttempted: number;
    toReset: number;
}

Hierarchy (View Summary)

RateLimit
ScreepsHttpRequest
- RateLimitEvent

Index

Properties

limit method params path period remaining reset retriesAttempted toReset

Properties

limit

limit: number

Maximum number of requests that can be sent within a given time period

method

method: ScreepsHttpMethod

params

params: unknown

path

path: string

period

period: RateLimitPeriod

Time period to which the limit applies

remaining

remaining: number

Remaining number of requests that can be sent until reset

reset

reset: number

UNIX timestamp (in seconds) indicating when the rate limit will automatically reset.

retriesAttempted

retriesAttempted: number

toReset

toReset: number

Time (in seconds) until reset