@fatcherjs/middleware-aborter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 fatcherjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# @fatcherjs/middleware-aborter
+
+A middleware for aborting fatcher request.
+
+## Install
+
+### NPM
+
+```bash
+>$ npm install @fatcherjs/middleware-aborter
+```
+
+### CDN
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js"></script>
+```
+
+## Usage
+
+```ts
+import { aborter } from '@fatcherjs/middleware-aborter';
+import { fatcher, isAbortError } from 'fatcher';
+
+fatcher({
+    url: '/bar/foo',
+    middlewares: [
+        aborter({
+            timeout: 10 * 1000, // 10s
+            onAbort: () => {
+                console.log('Request is Aborted.');
+            },
+        }),
+    ],
+})
+    .then(res => {
+        // Request success in 10s
+        console.log(res);
+    })
+    .catch(err => {
+        if (isAbortError(err)) {
+            //Run error when request aborted.
+            console.error(err);
+        }
+
+        // Other errors.
+    });
+```
+
+## Options
+
+### timeout
+
+-   Type: `number`
+-   DefaultValue: `0`
+-   Description:
+
+If `timeout > 0`, will abort this request later.
+
+Aborted request will throw a DOMException which can use `isAbortError` to confirm.
+
+### onAbort
+
+-   Type: `(() => void) | null`
+-   DefaultValue: `null`
+-   Description:
+
+A callback when aborting this request.
+
+## License
+
+[MIT](../../LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { Middleware } from 'fatcher';
+
+interface AborterOptions {
+    /**
+     * Request timeout
+     *
+     * `ms`
+     *
+     * @default 0
+     */
+    timeout?: number;
+    /**
+     * Callback with aborted request.
+     *
+     * @default null
+     */
+    onAbort?: (() => void) | null;
+}
+
+/**
+ * A middleware for aborting fatcher request.
+ * @param options
+ * @returns
+ */
+declare function aborter(options?: AborterOptions): Middleware;
+
+export { AborterOptions, aborter };

package/dist/index.esm.js

@@ -0,0 +1,31 @@
+import { warn } from 'fatcher';
+
+function aborter(options = {}) {
+  const { timeout = 0, onAbort = null } = options;
+  let _timeout = timeout;
+  if (isNaN(timeout) || ~~timeout <= 0) {
+    warn("<Aborter> Timeout is not a valid number.");
+    _timeout = 0;
+  }
+  return {
+    name: "fatcher-middleware-aborter",
+    async use(context, next) {
+      const abortController = new AbortController();
+      const requestTask = next({
+        signal: abortController.signal
+      });
+      if (!_timeout) {
+        return requestTask;
+      }
+      const timer = setTimeout(() => {
+        abortController.abort();
+        onAbort == null ? void 0 : onAbort();
+      }, _timeout);
+      const response = await requestTask;
+      clearTimeout(timer);
+      return response;
+    }
+  };
+}
+
+export { aborter };

package/dist/index.js

@@ -0,0 +1,35 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fatcher = require('fatcher');
+
+function aborter(options = {}) {
+  const { timeout = 0, onAbort = null } = options;
+  let _timeout = timeout;
+  if (isNaN(timeout) || ~~timeout <= 0) {
+    fatcher.warn("<Aborter> Timeout is not a valid number.");
+    _timeout = 0;
+  }
+  return {
+    name: "fatcher-middleware-aborter",
+    async use(context, next) {
+      const abortController = new AbortController();
+      const requestTask = next({
+        signal: abortController.signal
+      });
+      if (!_timeout) {
+        return requestTask;
+      }
+      const timer = setTimeout(() => {
+        abortController.abort();
+        onAbort == null ? void 0 : onAbort();
+      }, _timeout);
+      const response = await requestTask;
+      clearTimeout(timer);
+      return response;
+    }
+  };
+}
+
+exports.aborter = aborter;

package/dist/index.min.js

@@ -0,0 +1 @@
+(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("fatcher")):typeof define=="function"&&define.amd?define(["exports","fatcher"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e.FatcherMiddlewareAborter={},e.Fatcher))})(this,function(e,t){"use strict";function u(a={}){const{timeout:r=0,onAbort:o=null}=a;let n=r;return(isNaN(r)||~~r<=0)&&(t.warn("<Aborter> Timeout is not a valid number."),n=0),{name:"fatcher-middleware-aborter",async use(l,c){const i=new AbortController,s=c({signal:i.signal});if(!n)return s;const f=setTimeout(()=>{i.abort(),o?.()},n),d=await s;return clearTimeout(f),d}}}e.aborter=u,Object.defineProperty(e,"__esModule",{value:!0})});

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@fatcherjs/middleware-aborter",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "browser": "dist/index.min.js",
+  "typings": "dist/index.d.ts",
+  "repository": "https://github.com/fatcherjs/middlewares/tree/master/packages/aborter",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "fatcher": "^1.0.0"
+  },
+  "scripts": {
+    "dev": "rimraf dist && rollup -c rollup.config.ts -w",
+    "build": "rimraf dist && rollup -c rollup.config.ts"
+  },
+  "readme": "# @fatcherjs/middleware-aborter\n\nA middleware for aborting fatcher request.\n\n## Install\n\n### NPM\n\n```bash\n>$ npm install @fatcherjs/middleware-aborter\n```\n\n### CDN\n\n```html\n<script src=\"https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js\"></script>\n```\n\n## Usage\n\n```ts\nimport { aborter } from '@fatcherjs/middleware-aborter';\nimport { fatcher, isAbortError } from 'fatcher';\n\nfatcher({\n    url: '/bar/foo',\n    middlewares: [\n        aborter({\n            timeout: 10 * 1000, // 10s\n            onAbort: () => {\n                console.log('Request is Aborted.');\n            },\n        }),\n    ],\n})\n    .then(res => {\n        // Request success in 10s\n        console.log(res);\n    })\n    .catch(err => {\n        if (isAbortError(err)) {\n            //Run error when request aborted.\n            console.error(err);\n        }\n\n        // Other errors.\n    });\n```\n\n## Options\n\n### timeout\n\n-   Type: `number`\n-   DefaultValue: `0`\n-   Description:\n\nIf `timeout > 0`, will abort this request later.\n\nAborted request will throw a DOMException which can use `isAbortError` to confirm.\n\n### onAbort\n\n-   Type: `(() => void) | null`\n-   DefaultValue: `null`\n-   Description:\n\nA callback when aborting this request.\n\n## License\n\n[MIT](../../LICENSE)\n"
+}