@smithy/fetch-http-handler 2.2.7 → 2.3.0

package/dist-cjs/fetch-http-handler.js

@@ -8,6 +8,12 @@ exports.keepAliveSupport = {
     supported: Boolean(typeof Request !== "undefined" && "keepalive" in new Request("https://[::1]")),
 };
 class FetchHttpHandler {
+    static create(instanceOrOptions) {
+        if (typeof (instanceOrOptions === null || instanceOrOptions === void 0 ? void 0 : instanceOrOptions.handle) === "function") {
+            return instanceOrOptions;
+        }
+        return new FetchHttpHandler(instanceOrOptions);
+    }
     constructor(options) {
         if (typeof options === "function") {
             this.configProvider = options().then((opts) => opts || {});

package/dist-es/fetch-http-handler.js

@@ -5,6 +5,12 @@ export const keepAliveSupport = {
     supported: Boolean(typeof Request !== "undefined" && "keepalive" in new Request("https://[::1]")),
 };
 export class FetchHttpHandler {
+    static create(instanceOrOptions) {
+        if (typeof instanceOrOptions?.handle === "function") {
+            return instanceOrOptions;
+        }
+        return new FetchHttpHandler(instanceOrOptions);
+    }
     constructor(options) {
         if (typeof options === "function") {
             this.configProvider = options().then((opts) => opts || {});

package/dist-types/fetch-http-handler.d.ts

@@ -1,25 +1,7 @@
 import { HttpHandler, HttpRequest, HttpResponse } from "@smithy/protocol-http";
+import type { FetchHttpHandlerOptions } from "@smithy/types";
 import { HttpHandlerOptions, Provider } from "@smithy/types";
-/**
- * Represents the http options that can be passed to a browser http client.
- */
-export interface FetchHttpHandlerOptions {
-    /**
-     * The number of milliseconds a request can take before being automatically
-     * terminated.
-     */
-    requestTimeout?: number;
-    /**
-     * Whether to allow the request to outlive the page. Default value is false.
-     *
-     * There may be limitations to the payload size, number of concurrent requests,
-     * request duration etc. when using keepalive in browsers.
-     *
-     * These may change over time, so look for up to date information about
-     * these limitations before enabling keepalive.
-     */
-    keepAlive?: boolean;
-}
+export { FetchHttpHandlerOptions };
 type FetchHttpHandlerConfig = FetchHttpHandlerOptions;
 /**
  * @internal
@@ -36,6 +18,11 @@ export declare const keepAliveSupport: {
 export declare class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
     private config?;
     private configProvider;
+    /**
+     * @returns the input if it is an HttpHandler of any class,
+     * or instantiates a new instance of this handler.
+     */
+    static create(instanceOrOptions?: HttpHandler<any> | FetchHttpHandlerConfig): FetchHttpHandler | HttpHandler<any>;
     constructor(options?: FetchHttpHandlerOptions | Provider<FetchHttpHandlerOptions | undefined>);
     destroy(): void;
     handle(request: HttpRequest, { abortSignal }?: HttpHandlerOptions): Promise<{
@@ -44,4 +31,3 @@ export declare class FetchHttpHandler implements HttpHandler<FetchHttpHandlerCon
     updateHttpClientConfig(key: keyof FetchHttpHandlerConfig, value: FetchHttpHandlerConfig[typeof key]): void;
     httpHandlerConfigs(): FetchHttpHandlerConfig;
 }
-export {};

package/dist-types/ts3.4/fetch-http-handler.d.ts

@@ -1,25 +1,7 @@
 import { HttpHandler, HttpRequest, HttpResponse } from "@smithy/protocol-http";
+import { FetchHttpHandlerOptions } from "@smithy/types";
 import { HttpHandlerOptions, Provider } from "@smithy/types";
-/**
- * Represents the http options that can be passed to a browser http client.
- */
-export interface FetchHttpHandlerOptions {
-    /**
-     * The number of milliseconds a request can take before being automatically
-     * terminated.
-     */
-    requestTimeout?: number;
-    /**
-     * Whether to allow the request to outlive the page. Default value is false.
-     *
-     * There may be limitations to the payload size, number of concurrent requests,
-     * request duration etc. when using keepalive in browsers.
-     *
-     * These may change over time, so look for up to date information about
-     * these limitations before enabling keepalive.
-     */
-    keepAlive?: boolean;
-}
+export { FetchHttpHandlerOptions };
 type FetchHttpHandlerConfig = FetchHttpHandlerOptions;
 /**
  * @internal
@@ -36,6 +18,11 @@ export declare const keepAliveSupport: {
 export declare class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
     private config?;
     private configProvider;
+    /**
+     * @returns the input if it is an HttpHandler of any class,
+     * or instantiates a new instance of this handler.
+     */
+    static create(instanceOrOptions?: HttpHandler<any> | FetchHttpHandlerConfig): FetchHttpHandler | HttpHandler<any>;
     constructor(options?: FetchHttpHandlerOptions | Provider<FetchHttpHandlerOptions | undefined>);
     destroy(): void;
     handle(request: HttpRequest, { abortSignal }?: HttpHandlerOptions): Promise<{
@@ -44,4 +31,3 @@ export declare class FetchHttpHandler implements HttpHandler<FetchHttpHandlerCon
     updateHttpClientConfig(key: keyof FetchHttpHandlerConfig, value: FetchHttpHandlerConfig[typeof key]): void;
     httpHandlerConfigs(): FetchHttpHandlerConfig;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smithy/fetch-http-handler",
-  "version": "2.2.7",
+  "version": "2.3.0",
   "description": "Provides a way to make requests",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
@@ -9,7 +9,7 @@
     "build:types": "yarn g:tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "stage-release": "rimraf ./.release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
-    "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+    "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo || exit 0",
     "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
     "format": "prettier --config ../../prettier.config.js --ignore-path ../.prettierignore --write \"**/*.{ts,md,json}\"",
     "extract:docs": "api-extractor run --local",
@@ -24,14 +24,14 @@
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
   "dependencies": {
-    "@smithy/protocol-http": "^3.0.10",
-    "@smithy/querystring-builder": "^2.0.14",
-    "@smithy/types": "^2.6.0",
+    "@smithy/protocol-http": "^3.0.11",
+    "@smithy/querystring-builder": "^2.0.15",
+    "@smithy/types": "^2.7.0",
     "@smithy/util-base64": "^2.0.1",
     "tslib": "^2.5.0"
   },
   "devDependencies": {
-    "@smithy/abort-controller": "^2.0.14",
+    "@smithy/abort-controller": "^2.0.15",
     "@tsconfig/recommended": "1.0.1",
     "@types/chai-as-promised": "^7.1.2",
     "chai": "^4.2.0",