durable-execution - v0.32.0
    Preparing search index...

    Type Alias TaskRetryOptions

    Configuration for automatic task retry behavior with exponential backoff.

    The delay between retries follows an exponential backoff pattern:

    delay = min(baseDelayMs * (delayMultiplier ^ attemptNumber), maxDelayMs)

    // Retry up to 5 times with exponential backoff
    const retryOptions: TaskRetryOptions = {
      maxAttempts: 5,
      baseDelayMs: 1000,    // Start with 1 second
      delayMultiplier: 2,   // Double each time
      maxDelayMs: 30000     // Cap at 30 seconds
    }
    // Results in delays: 1s, 2s, 4s, 8s, 16s (capped)

    // Constant delay (no backoff)
    const constantRetry: TaskRetryOptions = {
      maxAttempts: 3,
      baseDelayMs: 5000,    // Always wait 5 seconds
      delayMultiplier: 1,   // No increase
    }
    // Results in delays: 5s, 5s, 5s

    // Immediate retry (no delay)
    const immediateRetry: TaskRetryOptions = {
      maxAttempts: 2,
      baseDelayMs: 0,       // No delay between retries
    }
    // Results in delays: 0s, 0s
    type TaskRetryOptions = {
        maxAttempts: number;
        baseDelayMs?: number;
        delayMultiplier?: number;
        maxDelayMs?: number;
    }
    Index

    Properties

    maxAttempts baseDelayMs? delayMultiplier? maxDelayMs?

    Properties

    maxAttempts: number

    The maximum number of times the task can be retried.

    baseDelayMs?: number

    The base delay before each retry in milliseconds. Defaults to 0 (immediate retry). When set to 0, retries happen immediately without delay.

    delayMultiplier?: number

    The multiplier for the delay before each retry. Defaults to 1 (constant delay). Values > 1 create exponential backoff, values < 1 create decreasing delays.

    maxDelayMs?: number

    The maximum delay before each retry in milliseconds. When specified, delays are capped at this value regardless of the exponential calculation.

    Settings

    Member Visibility

    On This Page

    Retry Delay Calculation
    Properties