regenerator-runtime

What is regenerator-runtime?

The regenerator-runtime package is a runtime module for Regenerator-compiled generator and async functions. It provides a polyfill for environments that do not natively support these features, allowing developers to use generators and async/await syntax in their JavaScript code.

What are regenerator-runtime's main functionalities?

Generator Function Support

Enables the use of generator functions, which can yield multiple values over time, allowing for more control over asynchronous operations.

function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

const g = gen();
console.log(g.next().value); // 1
console.log(g.next().value); // 2
console.log(g.next().value); // 3

Async/Await Support

Allows the use of async/await syntax for writing asynchronous code in a more synchronous fashion, improving readability and maintainability.

async function fetchData() {
  const data = await fetch('https://api.example.com/data');
  return data.json();
}

fetchData().then(data => console.log(data));

Other packages similar to regenerator-runtime

babel-polyfill

Babel-polyfill includes regenerator-runtime along with a full ES2015+ environment polyfill. It is more comprehensive but also larger in size compared to regenerator-runtime, which focuses only on generator and async function support.

core-js

Core-js is a modular standard library for JavaScript, which includes polyfills for ECMAScript features. It provides similar functionality to regenerator-runtime but also includes polyfills for other features such as Promises, Symbols, Collections, Iterators, and more.

es6-promise

While not providing generator or async function support, es6-promise is a lightweight library that offers a polyfill for Promises, which are often used in conjunction with async/await syntax. It is more focused compared to regenerator-runtime, which provides broader support for ES2015+ features.

README

regenerator-runtime

Standalone runtime for Regenerator-compiled generator and async functions.

To import the runtime as a module (recommended), either of the following import styles will work:

// CommonJS
const regeneratorRuntime = require("regenerator-runtime");

// ECMAScript 2015
import regeneratorRuntime from "regenerator-runtime";

To ensure that regeneratorRuntime is defined globally, either of the following styles will work:

// CommonJS
require("regenerator-runtime/runtime");

// ECMAScript 2015
import "regenerator-runtime/runtime";

To get the absolute file system path of runtime.js, evaluate the following expression:

require("regenerator-runtime/path").path