You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 1, 2025. It is now read-only.
This package implements a fully-functional source transformation that
takes the syntax for generators/yield from ECMAScript 2015 or ES2015 and Asynchronous Iteration proposal and
spits out efficient JS-of-today (ES5) that behaves the same way.
A small runtime library (less than 1KB compressed) is required to provide the
wrapGenerator function. You can install it either as a CommonJS module
or as a standalone .js file, whichever you prefer.
Installation
From npm:
npm install -g regenerator
From GitHub:
cd path/to/node_modules
git clone git://github.com/facebook/regenerator.git
cd regenerator
npm install .
npm test
Usage
You have several options for using this module.
Simplest usage:
regenerator es6.js > es5.js # Just the transform.
regenerator --include-runtime es6.js > es5.js # Add the runtime too.
regenerator src lib # Transform every .js file in src and output to lib.
The easiest way to get involved is to look for buggy examples using the
sandbox, and when you find
something strange just click the "report a bug" link (the new issue form
will be populated automatically with the problematic code).
Alternatively, you can
fork the repository,
create some failing tests cases in test/tests.es6.js,
and send pull requests for me to fix.
If you're feeling especially brave, you are more than welcome to dive into
the transformer code and fix the bug(s) yourself, but I must warn you that
the code could really benefit from better implementation
comments.
About
Source transformer enabling ECMAScript 6 generator functions in JavaScript-of-today.