TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
52 lines
1.9 KiB
Plaintext
52 lines
1.9 KiB
Plaintext
# generator-function <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
|
|
|
[![github actions][actions-image]][actions-url]
|
|
[![coverage][codecov-image]][codecov-url]
|
|
[![License][license-image]][license-url]
|
|
[![Downloads][downloads-image]][downloads-url]
|
|
|
|
[![npm badge][npm-badge-png]][package-url]
|
|
|
|
A function that returns the normally hidden `GeneratorFunction` constructor, when available.
|
|
|
|
## Getting started
|
|
|
|
```sh
|
|
npm install --save generator-function
|
|
```
|
|
|
|
## Usage/Examples
|
|
|
|
```js
|
|
const assert = require('assert');
|
|
const GeneratorFunction = require('generator-function')();
|
|
|
|
const fn = new GeneratorFunction('return 1');
|
|
|
|
assert.equal(fn.toString(), 'function* anonymous(\n) {\nreturn 1\n}');
|
|
|
|
const iterator = fn();
|
|
|
|
assert.deepEqual(iterator.next(), { done: true, value: 1 });
|
|
```
|
|
|
|
## Tests
|
|
|
|
Clone the repo, `npm install`, and run `npm test`
|
|
|
|
[package-url]: https://npmjs.org/package/generator-function
|
|
[npm-version-svg]: https://versionbadg.es/TimothyGu/generator-function.svg
|
|
[deps-svg]: https://david-dm.org/TimothyGu/generator-function.svg
|
|
[deps-url]: https://david-dm.org/TimothyGu/generator-function
|
|
[dev-deps-svg]: https://david-dm.org/TimothyGu/generator-function/dev-status.svg
|
|
[dev-deps-url]: https://david-dm.org/TimothyGu/generator-function#info=devDependencies
|
|
[npm-badge-png]: https://nodei.co/npm/generator-function.png?downloads=true&stars=true
|
|
[license-image]: https://img.shields.io/npm/l/generator-function.svg
|
|
[license-url]: LICENSE
|
|
[downloads-image]: https://img.shields.io/npm/dm/generator-function.svg
|
|
[downloads-url]: https://npm-stat.com/charts.html?package=generator-function
|
|
[codecov-image]: https://codecov.io/gh/TimothyGu/generator-function/branch/main/graphs/badge.svg
|
|
[codecov-url]: https://app.codecov.io/gh/TimothyGu/generator-function/
|
|
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/TimothyGu/generator-function
|
|
[actions-url]: https://github.com/TimothyGu/generator-function/actions
|