@aws-sdk/types - npm Package Compare versions

Comparing version 3.290.0 to 3.292.0

dist-types/abort.d.ts

@@ -41,3 +41,3 @@ /**
      * An object that reports whether the action associated with this
-     * {AbortController} has been cancelled.
+     * `AbortController` has been cancelled.
      */
@@ -44,0 +44,0 @@ readonly signal: AbortSignal;

dist-types/auth.d.ts

@@ -21,3 +21,3 @@ /**
      * @example ["*"]
-     * @exammple ["us-west-2", "us-east-1"]
+     * @example ["us-west-2", "us-east-1"]
      */
@@ -24,0 +24,0 @@ signingRegionSet?: string[];

dist-types/checksum.d.ts

@@ -35,3 +35,3 @@ import { SourceData } from "./crypto";
      *
-     * @param {number} readLimit - The maximum limit of bytes that can be read
+     * @param readLimit - The maximum limit of bytes that can be read
      *   before the mark position becomes invalid.
@@ -51,3 +51,3 @@ */
      *
-     * @param {Uint8Array} chunk - The buffer to update checksum with.
+     * @param chunk - The buffer to update checksum with.
      */
@@ -54,0 +54,0 @@ update(chunk: Uint8Array): void;

dist-types/credentials.d.ts

@@ -8,3 +8,3 @@ import { AwsCredentialIdentity } from "./identity";
  *
- * @deprecated Use {@AwsCredentialIdentity}
+ * @deprecated Use {@link AwsCredentialIdentity}
  */
@@ -16,4 +16,4 @@ export interface Credentials extends AwsCredentialIdentity {
  *
- * @deprecated Use {@AwsCredentialIdentityProvider}
+ * @deprecated Use {@link AwsCredentialIdentityProvider}
  */
 export declare type CredentialProvider = Provider<Credentials>;

dist-types/dns.d.ts

@@ -68,3 +68,3 @@ /**
      * high level abstractions provided in their language runtimes/libraries.
-     * @param args arguments with host name query addresses for
+     * @param args - arguments with host name query addresses for
      * @returns promise with a list of {@link HostAddress}
@@ -76,3 +76,3 @@ */
      * can accomodate the failure and likely not return the address until it recovers.
-     * @param addr host address to report a failure on
+     * @param addr - host address to report a failure on
      */
@@ -84,5 +84,5 @@ reportFailureOnAddress(addr: HostAddress): void;
      * implemented) is emptied for all host names.
-     * @param args optional arguments to empty the cache for
+     * @param args - optional arguments to empty the cache for
      */
     purgeCache(args?: HostResolverArguments): void;
 }

dist-types/http.d.ts

@@ -12,4 +12,4 @@ import { AbortSignal } from "./abort";
      *
-     * @param headerName    The name of the header to add or overwrite
-     * @param headerValue   The value to which the header should be set
+     * @param headerName - The name of the header to add or overwrite
+     * @param headerValue - The value to which the header should be set
      */
@@ -21,3 +21,3 @@ withHeader(headerName: string, headerValue: string): Headers;
      *
-     * @param headerName    The name of the header to remove
+     * @param headerName - The name of the header to remove
      */
@@ -37,2 +37,3 @@ withoutHeader(headerName: string): Headers;
  *
+ * ```json
  *    {
@@ -42,2 +43,3 @@ *        'x-amz-date': '2000-01-01T00:00:00Z',
  *    }
+ * ```
  *
@@ -47,4 +49,2 @@ * The SDK may at any point during processing remove one of the object
  * the SDK will not deterministically select which header candidate to use.
- *
- * @deprecated Replaced by implementation Fields in @aws-sdk/protocol-http.
  */
@@ -57,4 +57,2 @@ export declare type HeaderBag = Record<string, string>;
  * body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
- *
- * @deprecated Replaced by implementation HttpRequest/HttpResponse in @aws-sdk/protocol-http.
  */
@@ -76,3 +74,3 @@ export interface HttpMessage {
  *
- * @deprecated use EndpointV2 from @aws-sdk/types.
+ * @deprecated use {@link EndpointV2} from `@aws-sdk/types`.
  */
@@ -91,4 +89,2 @@ export interface Endpoint {
  * addressing information in addition to standard message properties.
- *
- * @deprecated Replaced by implementation HttpRequest in @aws-sdk/protocol-http.
  */
@@ -95,0 +91,0 @@ export interface HttpRequest extends HttpMessage, Endpoint {

dist-types/identity/Identity.d.ts

@@ -6,3 +6,3 @@ /**
     /**
-     * A {Date} when the identity or credential will no longer be accepted.
+     * A `Date` when the identity or credential will no longer be accepted.
      */
@@ -9,0 +9,0 @@ readonly expiration?: Date;

dist-types/logger.d.ts

@@ -8,3 +8,3 @@ /**
  *
- * @example new Logger({logLevel: 'warn'}) will print all the warn and error
+ * @example `new Logger({logLevel: 'warn'})` will print all the warn and error
  * message.
@@ -11,0 +11,0 @@ */

dist-types/middleware.d.ts

@@ -91,3 +91,3 @@ import { AuthScheme, HttpAuthDefinition } from "./auth";
      *
-     * @param args  An object containing a input to the command as well as any
+     * @param args - An object containing a input to the command as well as any
      *              associated or previously generated execution artifacts.
@@ -108,3 +108,3 @@ */
      *
-     * @param args  An object containing a input to the command as well as any
+     * @param args - An object containing a input to the command as well as any
      *              associated or previously generated execution artifacts.
@@ -121,3 +121,3 @@ */
      *
-     * @param args  An object containing a input to the command as well as any
+     * @param args - An object containing a input to the command as well as any
      *              associated or previously generated execution artifacts.
@@ -142,3 +142,3 @@ */
  *
- * A factory function that creates functions implementing the {Handler}
+ * A factory function that creates functions implementing the `Handler`
  * interface.
@@ -148,6 +148,6 @@ */
     /**
-     * @param next The handler to invoke after this middleware has operated on
+     * @param next - The handler to invoke after this middleware has operated on
      * the user input and before this middleware operates on the output.
      *
-     * @param context Invariant data and functions for use by the handler.
+     * @param context - Invariant data and functions for use by the handler.
      */
@@ -159,3 +159,3 @@ (next: InitializeHandler<Input, Output>, context: HandlerExecutionContext): InitializeHandler<Input, Output>;
  *
- * A factory function that creates functions implementing the {BuildHandler}
+ * A factory function that creates functions implementing the `BuildHandler`
  * interface.
@@ -165,6 +165,6 @@ */
     /**
-     * @param next The handler to invoke after this middleware has operated on
+     * @param next - The handler to invoke after this middleware has operated on
      * the user input and before this middleware operates on the output.
      *
-     * @param context Invariant data and functions for use by the handler.
+     * @param context - Invariant data and functions for use by the handler.
      */
@@ -176,3 +176,3 @@ (next: SerializeHandler<Input, Output>, context: HandlerExecutionContext): SerializeHandler<Input, Output>;
  *
- * A factory function that creates functions implementing the {FinalizeHandler}
+ * A factory function that creates functions implementing the `FinalizeHandler`
  * interface.
@@ -182,6 +182,6 @@ */
     /**
-     * @param next The handler to invoke after this middleware has operated on
+     * @param next - The handler to invoke after this middleware has operated on
      * the user input and before this middleware operates on the output.
      *
-     * @param context Invariant data and functions for use by the handler.
+     * @param context - Invariant data and functions for use by the handler.
      */
@@ -254,3 +254,3 @@ (next: FinalizeHandler<Input, Output>, context: HandlerExecutionContext): FinalizeHandler<Input, Output>;
      *
-     * @default 'initialize'
+     * @defaultValue 'initialize'
      */
@@ -282,3 +282,3 @@ step?: Step;
      *
-     * @default 'normal'
+     * @defaultValue 'normal'
      */
@@ -454,3 +454,3 @@ priority?: Priority;
     /**
-     * Resolved by the endpointMiddleware function of @aws-sdk/middleware-endpoint
+     * Resolved by the endpointMiddleware function of `@aws-sdk/middleware-endpoint`
      * in the serialization stage.
@@ -457,0 +457,0 @@ */

dist-types/profile.d.ts

@@ -8,3 +8,3 @@ /**
  *
- * @deprecated: Please use IniSection
+ * @deprecated Please use {@link IniSection}
  */
@@ -11,0 +11,0 @@ export interface Profile extends IniSection {

dist-types/retry.d.ts

@@ -57,3 +57,3 @@ /**
      * Sets the delayBase used to compute backoff delays.
-     * @param delayBase
+     * @param delayBase -
      */
@@ -101,3 +101,3 @@ setDelayBase(delayBase: number): void;
      *
-     * @param amount of tokens to release.
+     * @param amount - of tokens to release.
      */
@@ -104,0 +104,0 @@ releaseRetryTokens(amount?: number): void;

dist-types/serde.d.ts

@@ -19,3 +19,3 @@ import { Endpoint } from "./http";
      *
-     * @param stream  The low-level native stream from browser or Nodejs runtime
+     * @param stream - The low-level native stream from browser or Nodejs runtime
      */
@@ -45,5 +45,5 @@ (stream: any): Promise<Uint8Array>;
      *
-     * @param input     The user input to serialize.
+     * @param input - The user input to serialize.
      *
-     * @param context    Context containing runtime-specific util functions.
+     * @param context - Context containing runtime-specific util functions.
      */
@@ -59,5 +59,5 @@ (input: any, context: Context): Promise<Request>;
      *
-     * @param output     The HTTP response received from the service
+     * @param output - The HTTP response received from the service
      *
-     * @param context    context containing runtime-specific util functions.
+     * @param context - context containing runtime-specific util functions.
      */
@@ -74,4 +74,4 @@ (output: ResponseType, context: Context): Promise<OutputType>;
  * This is also required for any clients with streaming interfaces where the corresponding
- * types are also referred. The type is only declared here once since this @aws-sdk/types
- * is depended by all @aws-sdk packages.
+ * types are also referred. The type is only declared here once since this `@aws-sdk/types`
+ * is depended by all `@aws-sdk` packages.
  */
@@ -78,0 +78,0 @@ declare global {

dist-types/shapes.d.ts

@@ -60,4 +60,3 @@ import { HttpResponse } from "./http";
  *
- * @deprecated
- * @see https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/
+ * @deprecated See {@link https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/}
  *
@@ -64,0 +63,0 @@ * This type should not be used in your application.

dist-types/signature.d.ts

@@ -5,4 +5,4 @@ import { HttpRequest } from "./http";
  *
- * A {Date} object, a unix (epoch) timestamp in seconds, or a string that can be
- * understood by the JavaScript {Date} constructor.
+ * A `Date` object, a unix (epoch) timestamp in seconds, or a string that can be
+ * understood by the JavaScript `Date` constructor.
  */
@@ -87,4 +87,4 @@ export declare type DateInput = number | string | Date;
      *
-     * @param requestToSign The request that should be signed.
-     * @param options       Additional signing options.
+     * @param requestToSign - The request that should be signed.
+     * @param options - Additional signing options.
      */
@@ -91,0 +91,0 @@ presign(requestToSign: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;

dist-types/token.d.ts

@@ -8,3 +8,3 @@ import { TokenIdentity } from "./identity";
  *
- * @deprecated Use {@TokenIdentity}
+ * @deprecated Use {@link TokenIdentity}
  */
@@ -16,4 +16,4 @@ export interface Token extends TokenIdentity {
  *
- * @deprecated Use {@TokenIdentityProvider}
+ * @deprecated Use {@link TokenIdentityProvider}
  */
 export declare type TokenProvider = Provider<Token>;

dist-types/util.d.ts

@@ -11,4 +11,4 @@ import { Endpoint } from "./http";
  * @example An encoder function that converts bytes to hexadecimal
- * representation would return `'deadbeef'` when given `new
- * Uint8Array([0xde, 0xad, 0xbe, 0xef])`.
+ * representation would return `'deadbeef'` when given
+ * `new Uint8Array([0xde, 0xad, 0xbe, 0xef])`.
  */
@@ -123,3 +123,3 @@ export interface Encoder {
      * Enables IPv6/IPv4 dualstack endpoint.
-     * @default false
+     * @defaultValue false
      */
@@ -129,3 +129,3 @@ useDualstackEndpoint: boolean;
      * Enables FIPS compatible endpoints.
-     * @default false
+     * @defaultValue false
      */
@@ -132,0 +132,0 @@ useFipsEndpoint: boolean;

package.json

 {
   "name": "@aws-sdk/types",
-  "version": "3.290.0",
+  "version": "3.292.0",
   "main": "./dist-cjs/index.js",
@@ -50,5 +50,8 @@ "module": "./dist-es/index.js",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
+  },
+  "typedoc": {
+    "entryPoint": "src/index.ts"
   }
 }

No alert changes

Worsened metrics

Total package byte prevSize

110935

decreased by-0.11%

Lines of code

3246

decreased by-0.15%

No dependency changes