themeparks - v9.0.0
    Preparing search index...

    Interface RetryConfig

    Retry configuration for the Transport.

    Semantics note: max is the number of retries beyond the initial attempt, not the total attempt count. A setting of max: 3 means the transport will make up to 4 total calls (1 initial + 3 retries) before giving up. A setting of max: 0 disables retries entirely and the transport will perform exactly one call.

    interface RetryConfig {
        max: number;
        maxRetryAfterMs?: number;
        on429: boolean;
        respectRemaining?: boolean;
    }
    Index
    max: number

    Maximum number of retries beyond the initial attempt.

    0 disables retries; 3 allows 1 initial + 3 retries = 4 total calls.

    maxRetryAfterMs?: number

    Longest Retry-After this client will sleep through, in milliseconds. Defaults to DEFAULT_MAX_RETRY_AFTER_MS.

    A REST 429 asks for seconds and is worth waiting out. A HISTORY 429 is a different animal: that budget is hourly, so a spent one can ask for most of an hour, and honouring it up to max times means a process that sits silent for hours and looks hung. Past this cap we do not sleep at all, and throw RateLimitError carrying retryAfterMs so the caller can checkpoint and come back.

    on429: boolean

    If true, HTTP 429 responses are retried (honouring Retry-After).

    respectRemaining?: boolean

    Wait out a window the server has already said is spent.

    When a response reports remaining: 0, the next request is a guaranteed 429 that also costs a unit of the caller's budget to be refused. Waiting for the reset it advertised is strictly better than sending it. Setting this false turns the client back into a purely reactive one.

    Defaults to true.