kinetex - v1.0.0-rc.1
    Preparing search index...

    Interface RetryConfig

    Retry policy configuration.

    interface RetryConfig {
        maxRetries: number;
        baseDelayMs: number;
        maxDelayMs: number;
        jitter: number;
        statuses: number[];
        onNetworkError: boolean;
        onTimeout: boolean;
        methods: HTTPMethod[];
        shouldRetry?: (context: RetryContext) => boolean | Promise<boolean>;
        onRetry?: (context: RetryContext, delayMs: number) => void | Promise<void>;
    }
    Index

    Properties

    maxRetries baseDelayMs maxDelayMs jitter statuses onNetworkError onTimeout methods shouldRetry? onRetry?

    Properties

    maxRetries: number

    Maximum number of retry attempts. Default: 3

    baseDelayMs: number

    Base delay in ms (exponential back-off base). Default: 300

    maxDelayMs: number

    Maximum delay cap in ms. Default: 30_000

    jitter: number

    Jitter factor 0–1. Default: 0.3

    statuses: number[]

    HTTP status codes that trigger a retry. Default: [408,429,500,502,503,504]

    onNetworkError: boolean

    Retry on network errors (ENETWORK). Default: true

    onTimeout: boolean

    Retry on timeout errors (ETIMEOUT). Default: false

    Timeouts indicate the server is genuinely slow for this request. Retrying will usually just time out again and burn the full timeout × maxRetries budget. Set to true only if your server has known transient latency spikes you want to ride out.

    methods: HTTPMethod[]

    HTTP methods eligible for retry. Default: ["GET","HEAD","PUT","DELETE","OPTIONS","TRACE"]

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

    Custom predicate — overrides statuses + onNetworkError when provided.

    Type Declaration

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

      • Parameters

        • context: RetryContext

          Retry context with request, response, error, and attempt info.

        Returns boolean | Promise<boolean>

    onRetry?: (context: RetryContext, delayMs: number) => void | Promise<void>

    Called before each retry with the upcoming delay.

    Settings

    Member Visibility

    On This Page

    Properties