abort-controller

An implementation of WHATWG AbortController interface.

import AbortController from "abort-controller"

const controller = new AbortController()
const signal = controller.signal

signal.addEventListener("abort", () => {
    console.log("aborted!")
})

controller.abort()

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

???? Installation

Use npm to install then use a bundler.

npm install 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

import AbortController from "abort-controller"
// or
const AbortController = require("abort-controller")

// or UMD version defines a global variable:
const AbortController = window.AbortControllerShim

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.

Current Tags

3.0.0 ... latest (6 years ago)
3.0.0 ... next (6 years ago)