RetryOptions class
Defines retry policies that can be passed as parameters to various operations.
Constructors
Retry |
Creates a new instance of RetryOptions with the supplied first retry and max attempts. |
Properties
backoff |
The retry backoff coefficient |
first |
The first retry interval (ms). Must be greater than 0. |
max |
The maximum number of attempts. |
max |
The max retry interval (ms). |
retry |
The timeout for retries (ms). |
Constructor Details
RetryOptions(number, number)
Creates a new instance of RetryOptions with the supplied first retry and max attempts.
new RetryOptions(firstRetryIntervalInMilliseconds: number, maxNumberOfAttempts: number)
Parameters
- firstRetryIntervalInMilliseconds
-
number
The first retry interval (ms). Must be greater than 0.
- maxNumberOfAttempts
-
number
The maximum number of attempts.
Property Details
backoffCoefficient
The retry backoff coefficient
backoffCoefficient: number
Property Value
number
firstRetryIntervalInMilliseconds
The first retry interval (ms). Must be greater than 0.
firstRetryIntervalInMilliseconds: number
Property Value
number
maxNumberOfAttempts
The maximum number of attempts.
maxNumberOfAttempts: number
Property Value
number
maxRetryIntervalInMilliseconds
The max retry interval (ms).
maxRetryIntervalInMilliseconds: number
Property Value
number
retryTimeoutInMilliseconds
The timeout for retries (ms).
retryTimeoutInMilliseconds: number
Property Value
number