@fatcherjs/middleware-aborter/package.json

{
  "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"
}