Interface ScreepsHttpRequest

Contains all information needed to submit an API request via ScreepsHttpClient.req.

This is included in ScreepsApiError, RateLimitEvent, and ScreepsHttpResponse. It allows response data to be matched to a request, or for requests to be retried if needed.

interface ScreepsHttpRequest {
    method: ScreepsHttpMethod;
    params: unknown;
    path: string;
    retriesAttempted: number;
}

Hierarchy (View Summary)

ScreepsHttpRequest
- RateLimitEvent
- ScreepsHttpResponse

Index

Properties

method params path retriesAttempted

Properties

method

method: ScreepsHttpMethod

params

params: unknown

path

path: string

retriesAttempted

retriesAttempted: number