• lib
• RetryConfiguration

Interface RetryConfiguration

Configure the retry logic for http calls. By default, this retries any request that returns a 429 3 times.

interface RetryConfiguration {
enabled?: boolean;
maxRetries?: number;
retryWhen?: number[];
}

Index

Properties

enabled?maxRetries?retryWhen?

Properties

Optionalenabled

enabled?: boolean

Configure the usage of retries. Defaults to true on the Management Client and false on the Authentication Client.

OptionalmaxRetries

maxRetries?: number

Configure the max amount of retries the SDK should do. Defaults to 3. Note: this budget is shared between HTTP status code retries (e.g. 429) and transient network error retries (e.g. ECONNRESET). For example, with maxRetries: 3, 2 network retries and 1 status code retry would exhaust the full budget.

OptionalretryWhen

retryWhen?: number[]

HTTP Status Codes on which the SDK should trigger retries. Note: transient network errors (ECONNRESET, EPIPE, ECONNABORTED) are always retried up to maxRetries regardless of this setting. Use enabled: false to disable all retries. Defaults to [429].

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties enabledmaxRetriesretryWhen