Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

abort-controller

Package Overview
Dependencies
1
Maintainers
1
Versions
11
Issues
File Explorer

Advanced tools

abort-controller

An implementation of WHATWG AbortController interface.

    3.0.0nextlatest

Version published
Maintainers
1
Weekly downloads
7,961,148
decreased by-10.14%

Weekly downloads

Changelog

Source

💥 Breaking Changes

  • #14 ... Now package.json has browser field with browser.js. This doesn't contain the shim of AbortController because all modern browsers support it. Therefore, it improves the experience when universal libraries use abort-controller package. Please use abort-controller/polyfill to support IE.

Readme

Source

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.

Keywords

FAQs

What is abort-controller?

An implementation of WHATWG AbortController interface.

Is abort-controller popular?

The npm package abort-controller receives a total of 7,548,659 weekly downloads. As such, abort-controller popularity was classified as popular.

Is abort-controller well maintained?

We found that abort-controller demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 30 Mar 2019

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc