@fatcherjs/middleware-aborter 3.0.0-alpha-8 → 3.0.0-alpha-10

package/README.md

@@ -18,51 +18,101 @@
 <script src="https://cdn.jsdelivr.net/npm/@fatcherjs/middleware-aborter/dist/index.min.js"></script>
 ```
 
-## Usage
+## Provider
+
+### FatcherRequest
+
+#### abort
 
 ```ts
-import { fatcher } from 'fatcher';
-import { aborter } from '@fatcherjs/middleware-aborter';
+declare module 'fatcher' {
+  interface FatcherRequest {
+    abort: (reason?: string) => void;
+  }
+}
+```
+
+Middleware can get a `abort` function after call `aborter`;
 
+```ts
 fatcher('https://foo.bar', {
   middlewares: [
-    aborter({
-      /* Options*/
-    }),
+    aborter(),
+    (req, next) => {
+      console.log(typeof req.abort); // 'function'
+      return next();
+    },
   ],
 });
 ```
 
-## Options
+## Usage
 
-### onAbort
+### Basic
 
 ```ts
 import { fatcher } from 'fatcher';
 import { aborter } from '@fatcherjs/middleware-aborter';
 
 fatcher('https://foo.bar', {
-  middlewares: [
-    aborter({
-      onAbort: () => console.log('aborted'),
-    }),
-  ],
+  onAbort: () => console.log('aborted'),
+  middlewares: [aborter()],
 });
 ```
 
-### timeout
+### Timeout
+
+```ts
+import { fatcher } from 'fatcher';
+import { aborter, timeout } from '@fatcherjs/middleware-aborter';
+
+fatcher('https://foo.bar', {
+  onAbort: () => console.log('aborted'),
+  timeout: 1000 * 10, // 10s
+  middlewares: [aborter(), timeout() /* must call after aborter */],
+});
+```
+
+### User Cancelable
 
 ```ts
 import { fatcher } from 'fatcher';
 import { aborter } from '@fatcherjs/middleware-aborter';
 
+const abortController = new AbortController();
+
 fatcher('https://foo.bar', {
-  middlewares: [
-    aborter({
-      timeout: 10 * 1000, // abort in 10 seconds
-    }),
-  ],
+  onAbort: () => console.log('aborted'),
+  abortController,
+  middlewares: [aborter()],
+}).catch(error => {
+  // abort error
+});
+
+abortController.abort();
+```
+
+### isAbortError
+
+```ts
+import { fatcher } from 'fatcher';
+import { aborter, isAbortError } from '@fatcherjs/middleware-aborter';
+
+const abortController = new AbortController();
+
+fatcher('https://foo.bar', {
+  onAbort: () => console.log('aborted'),
+  abortController,
+  middlewares: [aborter()],
+}).catch(error => {
+  if (isAbortError(error)) {
+    // do something..
+    return;
+  }
+  // other error
 });
+
+abortController.abort();
 ```
 
 ## License

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import { FatcherMiddleware } from 'fatcher';
 
+declare const aborter: () => FatcherMiddleware;
+
 /**
  * Confirm an error whether is DOMException
  * @param error
@@ -7,18 +9,17 @@ import { FatcherMiddleware } from 'fatcher';
  */
 declare function isAbortError(error: unknown): error is DOMException;
 
-interface AborterOptions {
-    timeout?: number;
-    signal?: AbortSignal;
-    abort?: () => void;
-    onAbort?: () => void;
-}
+declare const timeout: () => FatcherMiddleware;
+
 declare module 'fatcher' {
     interface FatcherRequest {
-        abort: () => void;
+        abort: (reason?: string) => void;
+    }
+    interface FatcherOptions {
+        timeout?: number;
+        onAbort?: (reason?: string) => void;
+        abortController?: AbortController;
     }
 }
 
-declare const aborter: (options?: AborterOptions) => FatcherMiddleware;
-
-export { AborterOptions, aborter, isAbortError };
+export { aborter, isAbortError, timeout };

package/dist/index.esm.js

@@ -1,30 +1,51 @@
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-const aborter = (options = {}) => {
+const aborter = () => {
   return async (req, next) => {
-    const { onAbort, timeout } = options;
-    const abortController = new AbortController();
+    const { onAbort, abortController = new AbortController() } = req.options;
+    const handler = () => {
+      onAbort?.(abortController.signal.reason);
+      abortController.signal.removeEventListener("abort", handler);
+    };
     if (onAbort) {
-      abortController.signal.addEventListener("abort", () => onAbort());
+      abortController.signal.addEventListener("abort", handler);
     }
-    const promise = next({
-      abort: abortController.abort,
+    const response = await next({
+      abort: abortController.abort.bind(abortController),
       signal: abortController.signal
     });
+    if (onAbort) {
+      abortController.signal.removeEventListener("abort", handler);
+    }
+    return response;
+  };
+};
+
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === "AbortError";
+}
+
+const timeout = () => {
+  return async (req, next) => {
+    const {
+      abort,
+      options: { timeout: _timeout }
+    } = req;
     let timer = null;
-    if (timeout) {
+    if (_timeout) {
       timer = setTimeout(() => {
-        abortController.abort();
-      }, timeout);
+        abort();
+      }, _timeout);
     }
-    const response = await promise;
-    if (timer) {
-      clearTimeout(timer);
+    let response;
+    try {
+      response = await next();
+    } catch (error) {
+      if (timer) {
+        clearTimeout(timer);
+      }
+      throw error;
     }
     return response;
   };
 };
 
-export { aborter, isAbortError };
+export { aborter, isAbortError, timeout };

package/dist/index.js

@@ -2,30 +2,51 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-function isAbortError(error) {
-  return error instanceof DOMException && error.name === "AbortError";
-}
-
-const aborter = (options = {}) => {
+const aborter = () => {
   return async (req, next) => {
-    const { onAbort, timeout } = options;
-    const abortController = new AbortController();
+    const { onAbort, abortController = new AbortController() } = req.options;
+    const handler = () => {
+      onAbort?.(abortController.signal.reason);
+      abortController.signal.removeEventListener("abort", handler);
+    };
     if (onAbort) {
-      abortController.signal.addEventListener("abort", () => onAbort());
+      abortController.signal.addEventListener("abort", handler);
     }
-    const promise = next({
-      abort: abortController.abort,
+    const response = await next({
+      abort: abortController.abort.bind(abortController),
       signal: abortController.signal
     });
+    if (onAbort) {
+      abortController.signal.removeEventListener("abort", handler);
+    }
+    return response;
+  };
+};
+
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === "AbortError";
+}
+
+const timeout = () => {
+  return async (req, next) => {
+    const {
+      abort,
+      options: { timeout: _timeout }
+    } = req;
     let timer = null;
-    if (timeout) {
+    if (_timeout) {
       timer = setTimeout(() => {
-        abortController.abort();
-      }, timeout);
+        abort();
+      }, _timeout);
     }
-    const response = await promise;
-    if (timer) {
-      clearTimeout(timer);
+    let response;
+    try {
+      response = await next();
+    } catch (error) {
+      if (timer) {
+        clearTimeout(timer);
+      }
+      throw error;
     }
     return response;
   };
@@ -33,3 +54,4 @@ const aborter = (options = {}) => {
 
 exports.aborter = aborter;
 exports.isAbortError = isAbortError;
+exports.timeout = timeout;

package/dist/index.min.js

@@ -1 +1 @@
-(function(e,t){typeof exports=="object"&&typeof module!="undefined"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis!="undefined"?globalThis:e||self,t(e.FatcherMiddlewareAborter={}))})(this,function(e){"use strict";function t(o){return o instanceof DOMException&&o.name==="AbortError"}const a=(o={})=>async(b,u)=>{const{onAbort:i,timeout:s}=o,r=new AbortController;i&&r.signal.addEventListener("abort",()=>i());const f=u({abort:r.abort,signal:r.signal});let n=null;s&&(n=setTimeout(()=>{r.abort()},s));const l=await f;return n&&clearTimeout(n),l};e.aborter=a,e.isAbortError=t,Object.defineProperty(e,"__esModule",{value:!0})});
+(function(t,i){typeof exports=="object"&&typeof module!="undefined"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(t=typeof globalThis!="undefined"?globalThis:t||self,i(t.FatcherMiddlewareAborter={}))})(this,function(t){"use strict";const i=()=>async(o,a)=>{const{onAbort:r,abortController:e=new AbortController}=o.options,n=()=>{r==null||r(e.signal.reason),e.signal.removeEventListener("abort",n)};r&&e.signal.addEventListener("abort",n);const s=await a({abort:e.abort.bind(e),signal:e.signal});return r&&e.signal.removeEventListener("abort",n),s};function u(o){return o instanceof DOMException&&o.name==="AbortError"}const l=()=>async(o,a)=>{const{abort:r,options:{timeout:e}}=o;let n=null;e&&(n=setTimeout(()=>{r()},e));let s;try{s=await a()}catch(c){throw n&&clearTimeout(n),c}return s};t.aborter=i,t.isAbortError=u,t.timeout=l,Object.defineProperty(t,"__esModule",{value:!0})});

package/package.json

@@ -13,14 +13,16 @@
     "dist"
   ],
   "peerDependencies": {
-    "fatcher": "3.0.0-alpha-8"
+    "fatcher": "3.0.0-alpha-10"
   },
   "devDependencies": {
-    "fatcher": "3.0.0-alpha-8"
+    "fatcher": "3.0.0-alpha-10"
   },
-  "version": "3.0.0-alpha-8",
+  "version": "3.0.0-alpha-10",
   "scripts": {
     "clean": "rimraf dist",
-    "build": "npm run clean && rollup -c rollup.config.ts"
+    "build": "npm run clean && rollup -c rollup.config.ts",
+    "test": "jest",
+    "test:cov": "jest --coverage"
   }
 }