screeps-api
    Preparing search index...

    Interface ScreepsClientConfig

    User-configurable options for ScreepsHttpClient

    DEFAULT_CLIENT_CONFIG for default values

    interface ScreepsClientConfig {
        defaultShard?: string;
        retry429Global: boolean;
        retry429InitDelay: number;
        retry429MaxDelay: number;
        retry429MaxRetries: number;
    }
    Index

    Properties

    defaultShard?: string

    Specifies a default shard name to use when one is not provided as an argument to a ScreepsHttpClient endpoint function.

    retry429Global: boolean

    Wait for a short period of time before automatically retriing requests that fail due to the global 120 requests/minute rate limit.

    retry429InitDelay: number

    Delay (in milliseconds) before the first retry attempt. Only applies to retries for endpoint-specific rate limits.

    retry429MaxDelay: number

    Maximum delay (in milliseconds) between retry attempts. Only applies to retries for endpoint-specific rate limits.

    retry429MaxRetries: number

    Maximum number of retry attempts. Exponential backoff is used to increase the delay between subsequent retry attempts. Only applies to retries for endpoint-specific rate limits.