Function parseRetryOptions

Parses and validates the retry options, merging them with default values.

Throws

  • If the validation fails.
  • parseRetryOptions(retryOptions?): {
        backoffMultiplier: number;
        initialDelay: number;
        retries: number;
    }

  • Parameters

    • OptionalretryOptions: {
          backoffMultiplier?: number;
          initialDelay?: number;
          retries?: number;
      }

      The retry options to be validated.

      • OptionalbackoffMultiplier?: number

        The multiplier to apply to the delay between subsequent retries. Optional and must be between 1 and 2.

      • OptionalinitialDelay?: number

        The initial delay before the first retry attempt in milliseconds. Optional and must be between 100 and 5000 ms.

      • Optionalretries?: number

        The number of retry attempts. Optional and must be between 0 and 5.

    Returns {
        backoffMultiplier: number;
        initialDelay: number;
        retries: number;
    }

    • The validated and merged retry options.
    • backoffMultiplier: number

      The multiplier to apply to the delay between subsequent retries. Must be between 1 and 2.

    • initialDelay: number

      The initial delay before the first retry attempt in milliseconds. Must be between 100 and 5000 ms.

    • retries: number

      The number of retry attempts. Must be between 0 and 5.

Settings

Member Visibility