Documentation
    Preparing search index...

    Interface RetryOptions

    interface RetryOptions {
        afterStatusCodes?: number[];
        factor?: number;
        maxRetryTime?: number;
        maxTimeout?: number;
        methods?: string[];
        minTimeout?: number;
        randomize?: boolean;
        retries?: number;
        shouldRetry?: (context: RetryContext) => boolean | Promise<boolean>;
        statusCodes?: number[];
        unref?: boolean;
    }
    Index

    Properties

    afterStatusCodes? factor? maxRetryTime? maxTimeout? methods? minTimeout? randomize? retries? shouldRetry? statusCodes? unref?

    Properties

    afterStatusCodes?: number[]

    The status codes to retry after

    Request will wait until the date, timeout, or timestamp given in the Retry-After header has passed to retry the request. If Retry-After is missing, the non-standard RateLimit-Reset header is used in its place as a fallback. If the provided status code is not in the list, the Retry-After header will be ignored.

    [413, 429, 503]
    factor?: number

    The exponential factor to use.

    2
    maxRetryTime?: number

    The maximum time (in milliseconds) that the retried operation is allowed to run.

    Infinity
    maxTimeout?: number

    The maximum number of milliseconds between two retries.

    Infinity
    methods?: string[]

    The methods to retry

    ['get', 'put', 'head', 'delete', 'options', 'trace']
    minTimeout?: number

    The number of milliseconds before starting the first retry.

    1000
    randomize?: boolean

    Randomizes the timeouts by multiplying a factor between 1-2.

    false
    retries?: number

    The maximum amount of times to retry the operation.

    2
    shouldRetry?: (context: RetryContext) => boolean | Promise<boolean>

    Called after built-in checks pass, before retrying. Return false to stop retrying.

    Type Declaration

      • (context: RetryContext): boolean | Promise<boolean>

      • Parameters

        • context: RetryContext

          The context of the retry

        Returns boolean | Promise<boolean>

        • Whether to retry the request
    statusCodes?: number[]

    The HTTP status codes to retry on. Status codes in the range 400-599.

    [408, 413, 429, 500, 502, 503, 504]
    unref?: boolean

    Whether to unref the setTimeout's.

    false

    Settings

    Member Visibility

    On This Page

    Properties