@aws-sdk/types 3.22.0 → 3.34.0

package/src/util.d.ts

@@ -0,0 +1,100 @@
+import { Endpoint } from "./http";
+import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput } from "./middleware";
+import { MetadataBearer } from "./response";
+/**
+ * A function that, given a TypedArray of bytes, can produce a string
+ * representation thereof.
+ *
+ * @example An encoder function that converts bytes to hexadecimal
+ * representation would return `'deadbeef'` when given `new
+ * Uint8Array([0xde, 0xad, 0xbe, 0xef])`.
+ */
+export interface Encoder {
+  (input: Uint8Array): string;
+}
+/**
+ * A function that, given a string, can derive the bytes represented by that
+ * string.
+ *
+ * @example A decoder function that converts bytes to hexadecimal
+ * representation would return `new Uint8Array([0xde, 0xad, 0xbe, 0xef])` when
+ * given the string `'deadbeef'`.
+ */
+export interface Decoder {
+  (input: string): Uint8Array;
+}
+/**
+ * A function that, when invoked, returns a promise that will be fulfilled with
+ * a value of type T.
+ *
+ * @example A function that reads credentials from shared SDK configuration
+ * files, assuming roles and collecting MFA tokens as necessary.
+ */
+export interface Provider<T> {
+  (): Promise<T>;
+}
+/**
+ * A function that, given a request body, determines the
+ * length of the body. This is used to determine the Content-Length
+ * that should be sent with a request.
+ *
+ * @example A function that reads a file stream and calculates
+ * the size of the file.
+ */
+export interface BodyLengthCalculator {
+  (body: any): number | undefined;
+}
+/**
+ * Interface that specifies the retry behavior
+ */
+export interface RetryStrategy {
+  /**
+   * The retry mode describing how the retry strategy control the traffic flow.
+   */
+  mode?: string;
+  /**
+   * the retry behavior the will invoke the next handler and handle the retry accordingly.
+   * This function should also update the $metadata from the response accordingly.
+   * @see {@link ResponseMetadata}
+   */
+  retry: <Input extends object, Output extends MetadataBearer>(
+    next: FinalizeHandler<Input, Output>,
+    args: FinalizeHandlerArguments<Input>
+  ) => Promise<FinalizeHandlerOutput<Output>>;
+}
+/**
+ * Parses a URL in string form into an Endpoint object.
+ */
+export interface UrlParser {
+  (url: string): Endpoint;
+}
+/**
+ * Object containing regionalization information of
+ * AWS services.
+ */
+export interface RegionInfo {
+  hostname: string;
+  partition: string;
+  path?: string;
+  signingService?: string;
+  signingRegion?: string;
+}
+/**
+ * Function returns designated service's regionalization
+ * information from given region. Each service client
+ * comes with its regionalization provider. it serves
+ * to provide the default values of related configurations
+ */
+export interface RegionInfoProvider {
+  (region: string, options?: any): Promise<RegionInfo | undefined>;
+}
+/**
+ * A tuple that represents an API name and optional version
+ * of a library built using the AWS SDK.
+ */
+export declare type UserAgentPair = [name: string, version?: string];
+/**
+ * User agent data that to be put into the request's user
+ * agent.
+ */
+export declare type UserAgent = UserAgentPair[];

package/src/waiter.d.ts

@@ -0,0 +1,32 @@
+import { AbortController } from "./abort";
+export interface WaiterConfiguration<Client> {
+  /**
+   * Required service client
+   */
+  client: Client;
+  /**
+   * The amount of time in seconds a user is willing to wait for a waiter to complete.
+   */
+  maxWaitTime: number;
+  /**
+   * @deprecated Use abortSignal
+   * Abort controller. Used for ending the waiter early.
+   */
+  abortController?: AbortController;
+  /**
+   * Abort Signal. Used for ending the waiter early.
+   */
+  abortSignal?: AbortController["signal"];
+  /**
+   * The minimum amount of time to delay between retries in seconds. This is the
+   * floor of the exponential backoff. This value defaults to service default
+   * if not specified. This value MUST be less than or equal to maxDelay and greater than 0.
+   */
+  minDelay?: number;
+  /**
+   * The maximum amount of time to delay between retries in seconds. This is the
+   * ceiling of the exponential backoff. This value defaults to service default
+   * if not specified. If specified, this value MUST be greater than or equal to 1.
+   */
+  maxDelay?: number;
+}

package/tsconfig.cjs.json

@@ -1,9 +1,8 @@
 {
   "compilerOptions": {
-    "declarationDir": "./dist/types",
-    "rootDir": "./src",
-    "outDir": "./dist/cjs",
-    "baseUrl": "."
+    "baseUrl": ".",
+    "outDir": "dist/cjs",
+    "rootDir": "src"
   },
   "extends": "../../tsconfig.cjs.json",
   "include": ["src/"]

package/tsconfig.es.json

@@ -1,10 +1,9 @@
 {
   "compilerOptions": {
+    "baseUrl": ".",
     "lib": ["es5", "es2015.promise", "es2015.collection", "es2015.iterable", "es2015.symbol.wellknown"],
-    "declarationDir": "./dist/types",
-    "rootDir": "./src",
-    "outDir": "./dist/es",
-    "baseUrl": "."
+    "outDir": "dist/es",
+    "rootDir": "src"
   },
   "extends": "../../tsconfig.es.json",
   "include": ["src/"]

package/tsconfig.types.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "declarationDir": "dist/types",
+    "rootDir": "src"
+  },
+  "extends": "../../tsconfig.types.json",
+  "include": ["src/"]
+}