Skip to main content

Interface: RetryConfig

internal.RetryConfig

Configuration for the Axios Copy to Clipboard method.

Properties

backoffType

Copy to Clipboard backoffType: Copy to Clipboard | Copy to Clipboard | Copy to Clipboard

Backoff Type; 'linear', 'static' or 'exponential'.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47


checkRetryAfter

Copy to Clipboard checkRetryAfter: Copy to Clipboard

Whether to check for 'Retry-After' header in response and use value as delay. Defaults to true.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51


currentRetryAttempt

Copy to Clipboard currentRetryAttempt: Copy to Clipboard

The number of retries already attempted.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13


httpMethodsToRetry

Copy to Clipboard httpMethodsToRetry: Copy to Clipboard[]

The HTTP Methods that will be automatically retried. Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE']

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26


instance

Copy to Clipboard instance: Copy to Clipboard

The instance of the axios object to which the interceptor is attached.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21


maxRetryAfter

Copy to Clipboard maxRetryAfter: Copy to Clipboard

Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55


maxRetryDelay

Copy to Clipboard maxRetryDelay: Copy to Clipboard

Ceiling for calculated delay (in ms) - delay will not exceed this value.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59


noResponseRetries

Copy to Clipboard noResponseRetries: Copy to Clipboard

When there is no response, the number of retries to attempt. Defaults to 2.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43


onRetryAttempt

Copy to Clipboard onRetryAttempt: (Copy to Clipboard: Copy to Clipboard<Copy to Clipboard, Copy to Clipboard>) => Copy to Clipboard

Type declaration

▸ (Copy to Clipboard): Copy to Clipboard

Function to invoke when a retry attempt is made.

Parameters
NameType
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>
Returns

Copy to Clipboard

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35


retry

Copy to Clipboard retry: Copy to Clipboard

The number of times to retry the request. Defaults to 3.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9


retryDelay

Copy to Clipboard retryDelay: Copy to Clipboard

The amount of time to initially delay the retry. Defaults to 100.

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17


shouldRetry

Copy to Clipboard shouldRetry: (Copy to Clipboard: Copy to Clipboard<Copy to Clipboard, Copy to Clipboard>) => Copy to Clipboard

Type declaration

▸ (Copy to Clipboard): Copy to Clipboard

Function to invoke which determines if you should retry

Parameters
NameType
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>
Returns

Copy to Clipboard

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39


statusCodesToRetry

Copy to Clipboard statusCodesToRetry: Copy to Clipboard[][]

The HTTP response status codes that will automatically be retried. Defaults to: [[100, 199], [429, 429], [500, 599]]

Defined in

medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31