Nutella with Pepperoni and Mushrooms
    Have ideas to improve npm?Join in the discussion! »

    abort-controller
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    abort-controller

    npm version Downloads/month Build Status Coverage Status Dependency Status

    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.

    📖 Usage

    Basic

    import AbortController from "abort-controller"
    // or
    const AbortController = require("abort-controller")
     
    // or UMD version defines a global variable:
    const 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 abort-controller/polyfill assigns the AbortController shim to the AbortController global variable if the native implementation was nothing.

    import "abort-controller/polyfill"
    // or
    require("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

    🍻 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.

    Install

    npm i abort-controller

    DownloadsWeekly Downloads

    4,807,366

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    76.3 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar