@smithy/types - npm Package Compare versions

Comparing version 4.14.2 to 4.14.3

dist-types/retry.d.ts

@@ -78,2 +78,5 @@ import type { SdkError } from "./shapes";
     /**
+     * Starts at 0 for the initial request, which is not a "retry" by definition.
+     * 1 indicates the first retry.
+     *
      * @returns the current count of retry.
@@ -83,2 +86,13 @@ */
     /**
+     * RetryStrategies implemented by `@smithy/core` will return tokens with a
+     * delay of zero.
+     *
+     * This is because the RetryStrategy token acquisition methods took over the
+     * task of idling for the delay period. If a user-implemented retry token
+     * contains a delay, the default Smithy retry middleware will still honor it.
+     *
+     * That is to say, you may either sleep within the RetryStrategy methods for acquiring
+     * the token, OR return a token with a retry delay that will cause the retry middleware
+     * to sleep.
+     *
      * @returns the number of milliseconds to wait before retrying an action.
@@ -91,2 +105,10 @@ */
     isLongPoll?(): boolean;
+    /**
+     * Delays that have already been executed by the time the token
+     * is accessible. This is needed for the token handler to understand what has happened.
+     * @internal
+     */
+    $retryLog?: {
+        acquisitionDelay?: number;
+    };
 }
@@ -122,2 +144,5 @@ /**
      * or returning an error.
+     *
+     * This method should either delay internally and return a token with 0 delay, OR
+     * do not sleep and return a token with the desired delay duration.
      */
@@ -124,0 +149,0 @@ refreshRetryTokenForRetry(tokenToRenew: RetryToken, errorInfo: RetryErrorInfo): Promise<RetryToken>;

package.json

 {
   "name": "@smithy/types",
-  "version": "4.14.2",
+  "version": "4.14.3",
   "scripts": {
@@ -5,0 +5,0 @@ "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'",

No alert changes

Improved metrics

Total package byte prevSize

152632

0.73%

Lines of code

4205

0.6%

No dependency changes