Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including node-abort-controller with all npm packages installed. Try it out:

var nodeAbortController = require("node-abort-controller")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

node-abort-controller v1.1.0

AbortController for Node based on EventEmitter

node-abort-controller

AbortController Polyfill for Node.JS based on EventEmitter

Build Status

Usage

import fetch from 'node-fetch'
import AbortController from 'node-abort-controller'

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

await fetch('https:/www.google.com', { signal })

// Abort after 500ms. Effectively a timeout
setTimeout(() => controller.abort(), 500)

Why would I use this?

You might not need to! Generally speaking, there are three environments your JavaScript code can run in:

  • Node
  • Modern Browsers (Not Internet Explorer)
  • Legacy Browsers (Mostly Internet Explorer)

For modern JS APIs, each environment would ideally get a polyfill:

  • only if it needs one
  • specific to the platform.

In practice, this is hard. Tooling such as webpack and browserify are great at making sure stuff works out of the box in all environments. But it is quite easy to fail on both points above. In all likelyhood, you end up shipping less than ideal polyfills on platforms that don't even need them. So what is a developer to do? In the case of fetch and AbortController I've done the work for you. This is a guide to that work.

If you are building a ...

Application running in modern browsers:

Congrats! You don't need a library or polyfill at all! Close this tab. Uninstall this package.

Application running in modern browsers AND node (such as a server side rendered JS app):

Use this package and node-fetch. It is minimally what you need.

Application supporting legacy browsers AND NOT node:

Use abort-controller and whatwg-fetch. These are more complete polyfills that will work in all browser environments.

Application supporting legacy browsers AND node:

Use abort-controller and cross-fetch. Same as above, except cross-fetch will polyfill correctly in both the browser and node.js

Library being consumed by other applications and using fetch internally:

Use this package and node-fetch. It is the smallest and least opinionated combination for your end users. Application developers targeting Internet Exploer will need to polyfill AbortController and fetch on their own. But your library won't be forcing unecessary polyfills on developers who only target modern browsers.

Goals

With the above guide in mind, this library has a very specific set of goals:

  1. Provide a minimal polyfill in node.js
  2. Do not provide a polyfill in any browser environment

This is the ideal for library authors who use fetch and AbortController internally and target both browser and node developers.

Prior Art

Thank you @mysticatea for https://github.com/mysticatea/abort-controller. It is a fantastic AbortController polyfill and ideal for many use cases.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free