Type alias RetryConfig

RetryConfig: {
    exponential: {
        initialWaitMs: number;
        maxRetryMs: number;
    };
    periodic: {
        initialWaitMs: number;
        intervalMs: number;
        maxRetryMs: number;
    };
}

The config required for the various retry algorithms

Type declaration

  • exponential: {
        initialWaitMs: number;
        maxRetryMs: number;
    }
    • initialWaitMs: number

      The initial delay, which will be doubled on every subsequent retry

    • maxRetryMs: number

      The max number of ms to retry before giving up and throwing a RetryTimeoutError. Note that this is an absolute value which includes time spent actually running the job. For example, if you set this to 1 hour and your job takes 30 minutes to run, you will only get 2 retries.

  • periodic: {
        initialWaitMs: number;
        intervalMs: number;
        maxRetryMs: number;
    }
    • initialWaitMs: number

      The initial delay

    • intervalMs: number

      The delay for all retries after the first one

    • maxRetryMs: number

      The max number of ms to retry before giving up and throwing a RetryTimeoutError. Note that this is an absolute value which includes time spent actually running the job. For example, if you set this to 1 hour and your job takes 30 minutes to run, you will only get 2 retries.

Generated using TypeDoc