Logos DX
    Preparing search index...

    Interface RetryOptions

    interface RetryOptions {
        backoff?: number;
        delay?: number;
        jitterFactor?: number;
        onRetry?: (error: Error, attempt: number) => void | Promise<void>;
        onRetryExhausted?: (error: Error) => any;
        retries?: number;
        shouldRetry?: (error: Error) => boolean;
        signal?: AbortSignal;
        throwLastError?: boolean;
    }
    Index

    Properties

    backoff? delay? jitterFactor? onRetry? onRetryExhausted? retries? shouldRetry? signal? throwLastError?

    Properties

    backoff?: number

    Multiplier for the delay between retries

    1
    delay?: number

    Delay between retries

    0
    jitterFactor?: number

    Jitter factor for the delay between retries

    0
    onRetry?: (error: Error, attempt: number) => void | Promise<void>

    Callback invoked before each retry attempt

    Type Declaration

      • (error: Error, attempt: number): void | Promise<void>

      • Parameters

        • error: Error

          last error encountered

        • attempt: number

          current attempt number

        Returns void | Promise<void>

    onRetryExhausted?: (error: Error) => any

    Callback invoked after all retry attempts have been exhausted. Use to take over error handling and return a fallback value.

    Type Declaration

      • (error: Error): any

      • Parameters

        • error: Error

          last error encountered

        Returns any

        fallback value

    retries?: number

    Number of retries

    3
    shouldRetry?: (error: Error) => boolean

    Function to determine if the function should be retried

    Type Declaration

      • (error: Error): boolean

      • Parameters

        • error: Error

          error to check

        Returns boolean

        true if the function should be retried

    signal?: AbortSignal

    Abort signal to cancel the retry

    throwLastError?: boolean

    Throw the last error encountered if all retries fail

    false

    Settings

    Member Visibility

    On This Page

    Properties