@fatcherjs/middleware-aborter 1.8.0 → 3.0.0-alpha-4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 fatcherjs
+Copyright (c) 2022 Fansy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,4 @@
-# @fatcherjs/middleware-aborter
-
-A middleware for aborting fatcher request.
+# @fatcher/middleware-aborter
 
 ## Install
 
@@ -13,49 +11,56 @@ A middleware for aborting fatcher request.
 ### CDN
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/aborter.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js"></script>
 ```
 
 ## Usage
 
 ```ts
+import { fatcher } from 'fatcher';
 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.
-    });
+
+fatcher('https://foo.bar', {
+  middlewares: [
+    aborter({
+      /* Options*/
+    }),
+  ],
+});
 ```
 
 ## Options
 
-| Name        | Description                                     | Type                                     | DefaultValue                                                                         |
-| ----------- | ----------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------ |
-| timeout     | If `timeout > 0`, will abort this request later | `number`                                 | `0`                                                                                  |
-| onAbort     | A callback when aborting this request           | `(() => void) \| null`                   | `null`                                                                               |
-| concurrency | Request concurrency restrictions                | `boolean`                                | `false`                                                                              |
-| groupBy     | Concurrency key                                 | `(context: Readonly<Context>) => string` | `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}` |
+### onAbort
+
+```ts
+import { fatcher } from 'fatcher';
+import { aborter } from '@fatcherjs/middleware-aborter';
+
+fatcher('https://foo.bar', {
+  middlewares: [
+    aborter({
+      onAbort: () => console.log('aborted'),
+    }),
+  ],
+});
+```
+
+### timeout
+
+```ts
+import { fatcher } from 'fatcher';
+import { aborter } from '@fatcherjs/middleware-aborter';
+
+fatcher('https://foo.bar', {
+  middlewares: [
+    aborter({
+      timeout: 10 * 1000, // abort in 10 seconds
+    }),
+  ],
+});
+```
 
 ## License
 
-[MIT](https://github.com/fatcherjs/fatcher/blob/master/LICENSE)
+[MIT](https://github.com/fanhaoyuan/fatcher/blob/master/LICENSE)

package/package.json

@@ -1,25 +1,27 @@
 {
   "name": "@fatcherjs/middleware-aborter",
-  "version": "1.8.0",
-  "main": "dist/aborter.js",
-  "module": "dist/aborter.esm.js",
-  "browser": "dist/aborter.min.js",
-  "typings": "dist/aborter.d.ts",
-  "license": "MIT",
+  "homepage": "https://github.com/fanhaoyuan/fatcher",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fanhaoyuan/fatcher.git"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "browser": "dist/index.min.js",
+  "typings": "dist/index.d.ts",
   "files": [
     "dist"
   ],
-  "homepage": "https://github.com/fatcherjs/fatcher/tree/master/packages/aborter",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/fatcherjs/fatcher.git"
+  "peerDependencies": {
+    "fatcher": "3.0.0-alpha-4"
   },
-  "dependencies": {
-    "fatcher": "^1.8.0"
+  "devDependencies": {
+    "fatcher": "3.0.0-alpha-4"
   },
+  "version": "3.0.0-alpha-4",
   "scripts": {
-    "dev": "rimraf dist && rollup -c rollup.config.ts -w",
-    "build": "rimraf dist && rollup -c rollup.config.ts",
-    "deploy": "pnpm run build && pnpm publish --no-git-check"
+    "clean": "rimraf dist",
+    "build": "npm run clean && rollup -c rollup.config.ts",
+    "tsc": "tsc --noEmit"
   }
 }

package/dist/aborter.d.ts

@@ -1,52 +0,0 @@
-import { Context, Middleware } from 'fatcher';
-
-declare type AbortReason = 'concurrency' | 'timeout' | 'manual';
-declare type AbortEventHandler = (type: AbortReason) => void;
-declare type RoadSign = {
-    abort: (type: AbortReason) => void;
-    timer: NodeJS.Timeout | null;
-    signal: AbortSignal;
-};
-declare type RoadMap = Record<string, RoadSign[]>;
-interface AborterOptions {
-    /**
-     * Request timeout
-     *
-     * `ms`
-     *
-     * @default 0
-     */
-    timeout?: number;
-    /**
-     * Callback with aborted request.
-     *
-     * @default null
-     */
-    onAbort?: AbortEventHandler | null;
-    /**
-     * Request concurrency restrictions
-     *
-     * @default false
-     */
-    concurrency?: boolean;
-    /**
-     * Concurrency key.
-     */
-    groupBy?: (context: Readonly<Context>) => string;
-}
-
-/**
- * A middleware for aborting fatcher request.
- * @param options
- * @returns
- */
-declare function aborter(options?: AborterOptions): Middleware;
-
-/**
- * Confirm an error whether is DOMException
- * @param error
- * @returns
- */
-declare function isAbortError(error: unknown): error is DOMException;
-
-export { AbortEventHandler, AbortReason, AborterOptions, RoadMap, RoadSign, aborter, isAbortError };

package/dist/aborter.esm.js

@@ -1,55 +0,0 @@
-const roadMap = {};
-function aborter(options = {}) {
-  const { timeout = 0, onAbort = null, concurrency, groupBy } = options;
-  let _timeout = timeout;
-  if (isNaN(timeout) || ~~timeout < 0) {
-    console.warn("[fatcher-middleware-aborter] Timeout is not a valid number.");
-    _timeout = 0;
-  }
-  return {
-    name: "fatcher-middleware-aborter",
-    async use(context, next) {
-      var _a, _b, _c;
-      const abortController = new AbortController();
-      const { abort, signal } = abortController;
-      const requestTask = next({ signal });
-      const group = (_a = groupBy == null ? void 0 : groupBy(context)) != null ? _a : `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`;
-      if (((_b = roadMap[group]) == null ? void 0 : _b.length) && concurrency) {
-        roadMap[group].forEach((item) => {
-          item.abort("concurrency");
-        });
-      }
-      (_c = roadMap[group]) != null ? _c : roadMap[group] = [];
-      const trigger = (reason) => {
-        abort.call(abortController);
-        onAbort == null ? void 0 : onAbort(reason);
-      };
-      roadMap[group].push({
-        abort: trigger,
-        timer: _timeout ? setTimeout(() => trigger("timeout"), _timeout) : null,
-        signal
-      });
-      signal.addEventListener("abort", () => {
-        roadMap[group] = roadMap[group].filter((item) => {
-          if (item.signal === signal) {
-            if (item.timer) {
-              clearTimeout(item.timer);
-            }
-            return false;
-          }
-          return true;
-        });
-        if (!roadMap[group].length) {
-          delete roadMap[group];
-        }
-      });
-      return requestTask;
-    }
-  };
-}
-
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-export { aborter, isAbortError };

package/dist/aborter.js

@@ -1,60 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const roadMap = {};
-function aborter(options = {}) {
-  const { timeout = 0, onAbort = null, concurrency, groupBy } = options;
-  let _timeout = timeout;
-  if (isNaN(timeout) || ~~timeout < 0) {
-    console.warn("[fatcher-middleware-aborter] Timeout is not a valid number.");
-    _timeout = 0;
-  }
-  return {
-    name: "fatcher-middleware-aborter",
-    async use(context, next) {
-      var _a, _b, _c;
-      const abortController = new AbortController();
-      const { abort, signal } = abortController;
-      const requestTask = next({ signal });
-      const group = (_a = groupBy == null ? void 0 : groupBy(context)) != null ? _a : `${context.url}_${context.method}_${new URLSearchParams(context.params).toString()}`;
-      if (((_b = roadMap[group]) == null ? void 0 : _b.length) && concurrency) {
-        roadMap[group].forEach((item) => {
-          item.abort("concurrency");
-        });
-      }
-      (_c = roadMap[group]) != null ? _c : roadMap[group] = [];
-      const trigger = (reason) => {
-        abort.call(abortController);
-        onAbort == null ? void 0 : onAbort(reason);
-      };
-      roadMap[group].push({
-        abort: trigger,
-        timer: _timeout ? setTimeout(() => trigger("timeout"), _timeout) : null,
-        signal
-      });
-      signal.addEventListener("abort", () => {
-        roadMap[group] = roadMap[group].filter((item) => {
-          if (item.signal === signal) {
-            if (item.timer) {
-              clearTimeout(item.timer);
-            }
-            return false;
-          }
-          return true;
-        });
-        if (!roadMap[group].length) {
-          delete roadMap[group];
-        }
-      });
-      return requestTask;
-    }
-  };
-}
-
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-exports.aborter = aborter;
-exports.isAbortError = isAbortError;

package/dist/aborter.min.js

@@ -1 +0,0 @@
-(function(t,e){typeof exports=="object"&&typeof module!="undefined"?e(exports):typeof define=="function"&&define.amd?define(["exports"],e):(t=typeof globalThis!="undefined"?globalThis:t||self,e(t.FatcherMiddlewareAborter={}))})(this,function(t){"use strict";const e={};function p(o={}){const{timeout:u=0,onAbort:s=null,concurrency:_,groupBy:c}=o;let l=u;return(isNaN(u)||~~u<0)&&(console.warn("[fatcher-middleware-aborter] Timeout is not a valid number."),l=0),{name:"fatcher-middleware-aborter",async use(i,v){var d,f,b;const m=new AbortController,{abort:y,signal:a}=m,w=v({signal:a}),r=(d=c==null?void 0:c(i))!=null?d:`${i.url}_${i.method}_${new URLSearchParams(i.params).toString()}`;((f=e[r])==null?void 0:f.length)&&_&&e[r].forEach(n=>{n.abort("concurrency")}),(b=e[r])!=null||(e[r]=[]);const h=n=>{y.call(m),s==null||s(n)};return e[r].push({abort:h,timer:l?setTimeout(()=>h("timeout"),l):null,signal:a}),a.addEventListener("abort",()=>{e[r]=e[r].filter(n=>n.signal===a?(n.timer&&clearTimeout(n.timer),!1):!0),e[r].length||delete e[r]}),w}}}function g(o){return o instanceof DOMException&&o.name==="AbortError"}t.aborter=p,t.isAbortError=g,Object.defineProperty(t,"__esModule",{value:!0})});