keq 2.1.2 → 2.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.2.0](https://github.com/keq-request/keq/compare/v2.1.2...v2.2.0) (2024-02-04)
+
+
+### Features
+
+* add .timeout(millisecond) ([b99009b](https://github.com/keq-request/keq/commit/b99009b6eb4a017d648a29a8b34b478dc22320ee))
+
 ## [2.1.2](https://github.com/keq-request/keq/compare/v2.1.1...v2.1.2) (2024-01-17)
 
 

package/README.md

@@ -6,10 +6,12 @@
 <h1 align="center" style="text-align: center">KEQ</h1>
 <!-- title -->
 
-[![version](https://img.shields.io/npm/v/keq.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/keq)
-[![downloads](https://img.shields.io/npm/dm/keq.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/keq)
-[![dependencies](https://img.shields.io/librariesio/release/npm/keq?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/keq)
-[![license](https://img.shields.io/npm/l/keq.svg?logo=github&style=for-the-badge)](https://www.npmjs.com/package/keq)
+[npm]: https://www.npmjs.com/package/keq
+
+[![version](https://img.shields.io/npm/v/keq.svg?logo=npm&style=for-the-badge)][npm]
+[![downloads](https://img.shields.io/npm/dm/keq.svg?logo=npm&style=for-the-badge)][npm]
+[![dependencies](https://img.shields.io/librariesio/release/npm/keq?logo=npm&style=for-the-badge)][npm]
+[![license](https://img.shields.io/npm/l/keq.svg?logo=github&style=for-the-badge)][npm]
 [![Codecov](https://img.shields.io/codecov/c/gh/keq-request/keq?logo=codecov&token=PLF0DT6869&style=for-the-badge)](https://codecov.io/gh/keq-request/keq)
 
 <!-- description -->
@@ -353,6 +355,17 @@ await request
 | `fetchAPI`                | Replace the defaulted `fetch` function used by `Keq`.                                                   |
 
 <!-- ###### The options with **DEPRECATED** will be removed in next major version -->
+​
+### Timeout
+
+Keq has built-in timeout function.
+
+```typescript
+await request
+  .get("http://test.com")
+  // 5000 milliseconds
+  .timeout(5000)
+```
 
 ### Flow Control
 
@@ -399,7 +412,6 @@ request
   .followControl("serial", 'animal')
   .end()
 ```
-​
 
 ### Middleware
 

package/dist/esm/src/create-request.js

@@ -9,6 +9,7 @@ import { proxyResponseMiddleware } from './middlewares/proxy-response-middleware
 import { retryMiddleware } from './middlewares/retry-middleware';
 import { serialFlowControlMiddleware } from './middlewares/serial-flow-control-middleware.js';
 import { KeqRouter } from './router/keq-router.js';
+import { timeoutMiddleware } from './middlewares/timeout-middleware.js';
 export function createRequest(options) {
     let baseOrigin = options?.baseOrigin;
     if (isBrowser() && !baseOrigin)
@@ -16,6 +17,7 @@ export function createRequest(options) {
     const appendMiddlewares = options?.initMiddlewares ? [...options.initMiddlewares] : [
         serialFlowControlMiddleware(),
         abortFlowControlMiddleware(),
+        timeoutMiddleware(),
         proxyResponseMiddleware(),
         fetchArgumentsMiddleware(),
         retryMiddleware(),

package/dist/esm/src/keq.d.ts

@@ -70,4 +70,5 @@ export declare class Keq<T> extends Core<T> {
     credentials(mod: RequestCredentials): this;
     mode(mod: RequestMode): this;
     flowControl(mode: KeqFlowControlMode, signal?: KeqFlowControlSignal): this;
+    timeout(milliseconds: number): this;
 }

package/dist/esm/src/keq.js

@@ -196,4 +196,8 @@ export class Keq extends Core {
         this.option('flowControl', flowControl);
         return this;
     }
+    timeout(milliseconds) {
+        this.option('timeout', { millisecond: milliseconds });
+        return this;
+    }
 }

package/dist/esm/src/middlewares/timeout-middleware.d.ts

@@ -0,0 +1,2 @@
+import { KeqMiddleware } from "../types/keq-middleware.js";
+export declare function timeoutMiddleware(): KeqMiddleware;

package/dist/esm/src/middlewares/timeout-middleware.js

@@ -0,0 +1,19 @@
+export function timeoutMiddleware() {
+    return async (ctx, next) => {
+        if (!ctx.options.timeout || ctx.options.timeout.millisecond <= 0) {
+            await next();
+            return;
+        }
+        if (ctx.request.signal) {
+            console.warn('[keq] request signal had be set manual, abort follow control will not take effect');
+            await next();
+            return;
+        }
+        const timeoutSignal = new AbortController();
+        ctx.request.signal = timeoutSignal.signal;
+        setTimeout(() => {
+            timeoutSignal.abort('timeout');
+        }, ctx.options.timeout.millisecond);
+        await next();
+    };
+}

package/dist/esm/src/types/keq-options.d.ts

@@ -1,6 +1,7 @@
 import { KeqFlowControl } from './keq-flow-control.js';
 import { KeqRetryDelay } from './keq-retry-delay';
 import { KeqRetryOn } from './keq-retry-on';
+import { KeqTimeout } from './keq-timeout.js';
 export interface KeqBuildInOptions {
     /**
      * replace the default fetch api
@@ -29,6 +30,7 @@ export interface KeqBuildInOptions {
         pathname: string;
     };
     flowControl?: KeqFlowControl;
+    timeout?: KeqTimeout;
 }
 export interface KeqOptionsWithFullResponse extends KeqBuildInOptions {
     resolveWithFullResponse: true;

package/dist/esm/src/types/keq-timeout.d.ts

@@ -0,0 +1,3 @@
+export interface KeqTimeout {
+    millisecond: number;
+}

package/dist/esm/src/types/keq-timeout.js

@@ -0,0 +1 @@
+export {};

package/dist/umd/src/create-request.js

@@ -4,7 +4,7 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "whatwg-url", "./is/is-browser", "./keq", "./middlewares/abort-flow-control-middleware.js", "./middlewares/fetch-arguments-middleware", "./middlewares/fetch-middleware", "./middlewares/proxy-response-middleware", "./middlewares/retry-middleware", "./middlewares/serial-flow-control-middleware.js", "./router/keq-router.js"], factory);
+        define(["require", "exports", "whatwg-url", "./is/is-browser", "./keq", "./middlewares/abort-flow-control-middleware.js", "./middlewares/fetch-arguments-middleware", "./middlewares/fetch-middleware", "./middlewares/proxy-response-middleware", "./middlewares/retry-middleware", "./middlewares/serial-flow-control-middleware.js", "./router/keq-router.js", "./middlewares/timeout-middleware.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -21,6 +21,7 @@
     const retry_middleware_1 = require("./middlewares/retry-middleware");
     const serial_flow_control_middleware_js_1 = require("./middlewares/serial-flow-control-middleware.js");
     const keq_router_js_1 = require("./router/keq-router.js");
+    const timeout_middleware_js_1 = require("./middlewares/timeout-middleware.js");
     function createRequest(options) {
         let baseOrigin = options?.baseOrigin;
         if ((0, is_browser_1.isBrowser)() && !baseOrigin)
@@ -28,6 +29,7 @@
         const appendMiddlewares = options?.initMiddlewares ? [...options.initMiddlewares] : [
             (0, serial_flow_control_middleware_js_1.serialFlowControlMiddleware)(),
             (0, abort_flow_control_middleware_js_1.abortFlowControlMiddleware)(),
+            (0, timeout_middleware_js_1.timeoutMiddleware)(),
             (0, proxy_response_middleware_1.proxyResponseMiddleware)(),
             (0, fetch_arguments_middleware_1.fetchArgumentsMiddleware)(),
             (0, retry_middleware_1.retryMiddleware)(),

package/dist/umd/src/keq.d.ts

@@ -70,4 +70,5 @@ export declare class Keq<T> extends Core<T> {
     credentials(mod: RequestCredentials): this;
     mode(mod: RequestMode): this;
     flowControl(mode: KeqFlowControlMode, signal?: KeqFlowControlSignal): this;
+    timeout(milliseconds: number): this;
 }

package/dist/umd/src/keq.js

@@ -208,6 +208,10 @@
             this.option('flowControl', flowControl);
             return this;
         }
+        timeout(milliseconds) {
+            this.option('timeout', { millisecond: milliseconds });
+            return this;
+        }
     }
     exports.Keq = Keq;
 });

package/dist/umd/src/middlewares/timeout-middleware.d.ts

@@ -0,0 +1,2 @@
+import { KeqMiddleware } from "../types/keq-middleware.js";
+export declare function timeoutMiddleware(): KeqMiddleware;

package/dist/umd/src/middlewares/timeout-middleware.js

@@ -0,0 +1,33 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.timeoutMiddleware = void 0;
+    function timeoutMiddleware() {
+        return async (ctx, next) => {
+            if (!ctx.options.timeout || ctx.options.timeout.millisecond <= 0) {
+                await next();
+                return;
+            }
+            if (ctx.request.signal) {
+                console.warn('[keq] request signal had be set manual, abort follow control will not take effect');
+                await next();
+                return;
+            }
+            const timeoutSignal = new AbortController();
+            ctx.request.signal = timeoutSignal.signal;
+            setTimeout(() => {
+                timeoutSignal.abort('timeout');
+            }, ctx.options.timeout.millisecond);
+            await next();
+        };
+    }
+    exports.timeoutMiddleware = timeoutMiddleware;
+});

package/dist/umd/src/types/keq-options.d.ts

@@ -1,6 +1,7 @@
 import { KeqFlowControl } from './keq-flow-control.js';
 import { KeqRetryDelay } from './keq-retry-delay';
 import { KeqRetryOn } from './keq-retry-on';
+import { KeqTimeout } from './keq-timeout.js';
 export interface KeqBuildInOptions {
     /**
      * replace the default fetch api
@@ -29,6 +30,7 @@ export interface KeqBuildInOptions {
         pathname: string;
     };
     flowControl?: KeqFlowControl;
+    timeout?: KeqTimeout;
 }
 export interface KeqOptionsWithFullResponse extends KeqBuildInOptions {
     resolveWithFullResponse: true;

package/dist/umd/src/types/keq-timeout.d.ts

@@ -0,0 +1,3 @@
+export interface KeqTimeout {
+    millisecond: number;
+}

package/dist/umd/src/types/keq-timeout.js

@@ -0,0 +1,12 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keq",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "Request API write by Typescript for flexibility, readability, and a low learning curve.",
   "keywords": [
     "request",