# gnode

> Run node with ES6 Generators, today!

Latest version **0.1.2** (published 2016-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install gnode
pnpm add gnode
yarn add gnode
bun add gnode
```

Provides the command `gnode`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2016-02-09 |
| First published | 2013-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 247 |
| Author | Nathan Rajlich |
| Maintainers | tootallnate |
| Keywords | node, generators, es6, facebook, regenerator, co |

## Links

- npm: https://www.npmjs.com/package/gnode
- Repository: https://github.com/TooTallNate/gnode
- Issues: https://github.com/TooTallNate/gnode/issues
- npm.io page: https://npm.io/package/gnode

## Dependencies (1)

- [regenerator](https://npm.io/package/regenerator.md) ~0.8.8

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads
- [datasets-fi-postalcodes](https://npm.io/package/datasets-fi-postalcodes.md) — 1.1K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2016-02-09
- 0.1.1 — 2015-01-14
- 0.1.0 — 2014-09-12
- 0.0.8 — 2014-04-29
- 0.0.7 — 2014-02-15
- 0.0.6 — 2014-01-06
- 0.0.5 — 2013-12-19
- 0.0.4 — 2013-11-11
- 0.0.3 — 2013-10-31
- 0.0.2 — 2013-10-31
- 0.0.1 — 2013-10-31

## README

gnode
=====
### Run node with ES6 Generators, today!
[![Build Status](https://travis-ci.org/TooTallNate/gnode.svg?branch=master)](https://travis-ci.org/TooTallNate/gnode)

`gnode` is a very light wrapper around your `node` executable that ensures
[ES6 Generator][generators] support, even on versions of node that do not
support ES6 Generators natively.

You use it exactly like the regular `node` executable, except that you _do not_
need to pass the `--harmony-generators` flag. That is where the magic happens.

With `gnode` you can use [`co`][co] or [`suspend`][suspend], or any other
Generator-based flow control based module, today!


How does this magic work?
-------------------------

#### node &lt; 0.11.3

When V8 provides no native ES6 generators support, then `gnode` invokes a node
instance with a patched `require.extensions['.js']` function, which transparently
transpiles your ES6 code with Generators into ES5-compatible code. We can thank
[`facebook/regenerator`][regenerator] for making this possible.

Under the hood, this command:

``` bash
$ gnode foo.js all the args
```

Turns into something like this:

``` bash
$ GNODE_ENTRY_POINT=foo.js node fallback.js all the args
```

#### node &gt;= 0.11.3

When V8 supports ES6 generators natively, then `gnode` invokes a node instance
with the `--harmony-generators` flag passed in transparently, so that the native
generators are used, and no transpiling takes place. Everything else _just works_
as you would expect it to.

Under the hood, this command:

``` bash
$ gnode foo.js all the args
```

Turns into something like this:

``` bash
$ node --harmony-generators foo.js all the args
```


Installation
------------

Install the `gnode` executable via npm:

``` bash
$ npm install -g gnode
```


CLI Examples
------------

The `gnode` executable uses whatever version of node is installed in your `PATH`:

Here's our example `t.js` file:

``` js
var co = require('co');

function sleep (ms) {
  return function (fn) {
    setTimeout(fn, ms);
  };
}

co(function* () {
  for (var i = 0; i < 5; i++) {
    console.log(i);
    yield sleep(1000);
  }
})();
```

This script with an ES6 Generator in it can be run using any version of node
by using `gnode`:

``` bash
☮ ~ (master) ∴ n 0.8.26

☮ ~ (master) ∴ gnode -v
v0.8.26

☮ ~ (master) ∴ gnode t.js
0
1
2
3
4

☮ ~ (master) ∴ n 0.10.21

☮ ~ (master) ∴ gnode -v
v0.10.21

☮ ~ (master) ∴ gnode t.js
0
1
2
3
4

☮ ~ (master) ∴ n 0.11.8

☮ ~ (master) ∴ gnode -v
v0.11.8

☮ ~ (master) ∴ gnode t.js
0
1
2
3
4
```


Programmatic API
----------------

You can also just `require('gnode')` in a script _without any generators_, and
then `require()` any other .js file that has generators after that.

``` js
require('gnode');
var gen = require('./someGenerator');
// etc…
```

[co]: https://github.com/visionmedia/co
[suspend]: https://github.com/jmar777/suspend
[generators]: http://wiki.ecmascript.org/doku.php?id=harmony:generators
[regenerator]: https://github.com/facebook/regenerator

---
_Source: https://npm.io/package/gnode · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
