mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-06 12:27:48 +00:00
24 lines
1.7 KiB
Markdown
24 lines
1.7 KiB
Markdown
# RetryConfig
|
|
|
|
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Description | Example |
|
|
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
|
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
|
|
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
|
|
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
|
|
|
|
## BackoffStrategy
|
|
|
|
The backoff strategy allows retrying a request with an exponential backoff between each retry.
|
|
|
|
### Fields
|
|
|
|
| Name | Type | Description | Example |
|
|
| ------------------ | ------------ | ----------------------------------------- | -------- |
|
|
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
|
|
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
|
|
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
|
|
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` | |