abort-controller-es5

abort-controller-es5

This package is based on abort-controller. It did not contains an ES5 module. Importing the module directly or indirectly may break web apps running on ES5 browsers.

On npm install, this package will transpile your version of abort-controller to make it compatible with ES5 browsers. Then in your code, you use abort-controller-es5 instead of abort-controller.

Package authors should consider importing this package instead of abort-controller, so your packages will not break your users due to having abort-controller as a transient dependency.

How to use

To install in your project, run:

npm install abort-controller abort-controller-es5

In your code:

const controller = new AbortController();

controller.signal.addEventListener('abort', event => {
  // Handle abort signal
});

controller.abort();

You can also use it in HTML:

<script src="https://unpkg.com/abort-controller-es5/dist/abort-controller-es5.production.min.js"></script>

How it works

On postinstall, this package will run esbuild to bundle abort-controller into a single file. Then run Babel to transpile it for ES5.

This package peer-depends on abort-controller. Thus, you can select your own version of abort-controller.

Updating abort-controller

When you update abort-controller, re-run npm install abort-controller-es5 to get the latest package transpiled.

Alternatives

Instead of importing this package, there are alternative workarounds you can use.

Including the source code

You can copy the source code of abort-controller into your web app and use your build pipeline transpile the original package.

Be sure to include the original license and continue to depends on the package to make sure npm audit will scan for vulnerabilities.

Modify your bundler configuration

Some bundlers is configured not to transpile code under /node_modules/ unless specified explicitly. You can modify bundler configuration to include /node_modules/abort-controller/ and use Babel to transpile it while bundling.

Contributions

Like us? Star us.

Want to make it better? File us an issue.

Don't like something you see? Submit a pull request.