@aws-sdk/middleware-retry

  • Version 3.296.0
  • Published
  • 59.6 kB
  • 7 dependencies
  • Apache-2.0 license

Install

npm i @aws-sdk/middleware-retry
yarn add @aws-sdk/middleware-retry
pnpm add @aws-sdk/middleware-retry

Overview

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-retry/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-retry) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-retry.svg)](https://www.npmjs.com/package/@aws

Index

Variables

variable CONFIG_MAX_ATTEMPTS

const CONFIG_MAX_ATTEMPTS: string;

    variable CONFIG_RETRY_MODE

    const CONFIG_RETRY_MODE: string;

      variable ENV_MAX_ATTEMPTS

      const ENV_MAX_ATTEMPTS: string;

        variable ENV_RETRY_MODE

        const ENV_RETRY_MODE: string;

          variable NODE_MAX_ATTEMPT_CONFIG_OPTIONS

          const NODE_MAX_ATTEMPT_CONFIG_OPTIONS: LoadedConfigSelectors<number>;

            variable NODE_RETRY_MODE_CONFIG_OPTIONS

            const NODE_RETRY_MODE_CONFIG_OPTIONS: LoadedConfigSelectors<string>;

              variable omitRetryHeadersMiddlewareOptions

              const omitRetryHeadersMiddlewareOptions: RelativeMiddlewareOptions;

                variable retryMiddlewareOptions

                const retryMiddlewareOptions: any;

                  Functions

                  function defaultDelayDecider

                  defaultDelayDecider: (delayBase: number, attempts: number) => number;
                  • Calculate a capped, fully-jittered exponential backoff time.

                  function defaultRetryDecider

                  defaultRetryDecider: (error: SdkError) => boolean;

                    function getOmitRetryHeadersPlugin

                    getOmitRetryHeadersPlugin: (options: unknown) => Pluggable<any, any>;

                      function getRetryAfterHint

                      getRetryAfterHint: (response: unknown) => Date | undefined;

                        function getRetryPlugin

                        getRetryPlugin: (options: RetryResolvedConfig) => Pluggable<any, any>;

                          function omitRetryHeadersMiddleware

                          omitRetryHeadersMiddleware: () => <
                          Output extends MetadataBearer = MetadataBearer
                          >(
                          next: FinalizeHandler<any, Output>
                          ) => FinalizeHandler<any, Output>;

                            function resolveRetryConfig

                            resolveRetryConfig: <T>(
                            input: T & PreviouslyResolved & RetryInputConfig
                            ) => T & RetryResolvedConfig;

                              function retryMiddleware

                              retryMiddleware: (
                              options: RetryResolvedConfig
                              ) => <Output extends MetadataBearer = MetadataBearer>(
                              next: FinalizeHandler<any, Output>,
                              context: HandlerExecutionContext
                              ) => FinalizeHandler<any, Output>;

                                Classes

                                class AdaptiveRetryStrategy

                                class AdaptiveRetryStrategy extends StandardRetryStrategy {}
                                • Deprecated

                                  use AdaptiveRetryStrategy from @aws-sdk/util-retry

                                constructor

                                constructor(
                                maxAttemptsProvider: Provider<number>,
                                options?: AdaptiveRetryStrategyOptions
                                );

                                  method retry

                                  retry: <Input extends object, Ouput extends MetadataBearer>(
                                  next: FinalizeHandler<Input, Ouput>,
                                  args: FinalizeHandlerArguments<Input>
                                  ) => Promise<{ response: unknown; output: Ouput }>;

                                    class StandardRetryStrategy

                                    class StandardRetryStrategy implements RetryStrategy {}
                                    • Deprecated

                                      use StandardRetryStrategy from @aws-sdk/util-retry

                                    constructor

                                    constructor(
                                    maxAttemptsProvider: Provider<number>,
                                    options?: StandardRetryStrategyOptions
                                    );

                                      property mode

                                      mode: string;

                                        method retry

                                        retry: <Input extends object, Ouput extends MetadataBearer>(
                                        next: FinalizeHandler<Input, Ouput>,
                                        args: FinalizeHandlerArguments<Input>,
                                        options?: { beforeRequest: Function; afterRequest: Function }
                                        ) => Promise<{ response: unknown; output: Ouput }>;

                                          Interfaces

                                          interface AdaptiveRetryStrategyOptions

                                          interface AdaptiveRetryStrategyOptions extends StandardRetryStrategyOptions {}
                                          • Strategy options to be passed to AdaptiveRetryStrategy

                                          property rateLimiter

                                          rateLimiter?: RateLimiter;

                                            interface RetryInputConfig

                                            interface RetryInputConfig {}

                                              property maxAttempts

                                              maxAttempts?: number | Provider<number>;
                                              • The maximum number of times requests that encounter retryable failures should be attempted.

                                              property retryStrategy

                                              retryStrategy?: RetryStrategy | RetryStrategyV2;
                                              • The strategy to retry the request. Using built-in exponential backoff strategy by default.

                                              interface RetryResolvedConfig

                                              interface RetryResolvedConfig {}

                                                property maxAttempts

                                                maxAttempts: Provider<number>;

                                                property retryStrategy

                                                retryStrategy: Provider<RetryStrategyV2 | RetryStrategy>;

                                                interface StandardRetryStrategyOptions

                                                interface StandardRetryStrategyOptions {}
                                                • Strategy options to be passed to StandardRetryStrategy

                                                property delayDecider

                                                delayDecider?: DelayDecider;

                                                  property retryDecider

                                                  retryDecider?: RetryDecider;

                                                    property retryQuota

                                                    retryQuota?: RetryQuota;

                                                      Package Files (8)

                                                      Dependencies (7)

                                                      Dev Dependencies (8)

                                                      Peer Dependencies (0)

                                                      No peer dependencies.

                                                      Badge

                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-sdk/middleware-retry.

                                                      • Markdown
                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-sdk/middleware-retry)
                                                      • HTML
                                                        <a href="https://www.jsdocs.io/package/@aws-sdk/middleware-retry"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>