@chainsafe/abort-controller

An implementation of WHATWG AbortController interface.

1import AbortController from "@chainsafe/abort-controller"
2
3const controller = new AbortController()
4const signal = controller.signal
5
6signal.addEventListener("abort", () => {
7    console.log("aborted!")
8})
9
10controller.abort()

https://jsfiddle.net/1r2994qp/1/

💿 Installation

Use npm to install then use a bundler.

npm install @chainsafe/abort-controller

Or download from dist directory.

• dist/abort-controller.mjs ... ES modules version.
• dist/abort-controller.js ... Common JS version.
• dist/abort-controller.umd.js ... UMD (Universal Module Definition) version. This is transpiled by Babel for IE 11.

📖 Usage

Basic

1import AbortController from "@chainsafe/abort-controller"
2// or
3const AbortController = require("@chainsafe/abort-controller")
4
5// or UMD version defines a global variable:
6const AbortController = window.AbortControllerShim

If your bundler recognizes browser field of package.json, the imported AbortController is the native one and it doesn't contain shim (even if the native implementation was nothing). If you wanted to polyfill AbortController for IE, use abort-controller/polyfill.

Polyfilling

Importing @chainsafe/abort-controller/polyfill assigns the AbortController shim to the AbortController global variable if the native implementation was nothing.

1import "@chainsafe/abort-controller/polyfill"
2// or
3require("@chainsafe/abort-controller/polyfill")

API

AbortController

https://dom.spec.whatwg.org/#interface-abortcontroller

controller.signal

The AbortSignal object which is associated to this controller.

controller.abort()

Notify abort event to listeners that the signal has.

📰 Changelog

• See GitHub releases.

🍻 Contributing

Contributing is welcome ❤️

Please use GitHub issues/PRs.

Development tools

• npm install installs dependencies for development.
• npm test runs tests and measures code coverage.
• npm run clean removes temporary files of tests.
• npm run coverage opens code coverage of the previous test with your default browser.
• npm run lint runs ESLint.
• npm run build generates dist codes.
• npm run watch runs tests on each file change.