https://github.com/blakeembrey/is-generator
Check whether a given value is a generator function
https://github.com/blakeembrey/is-generator
Last synced: 12 months ago
JSON representation
Check whether a given value is a generator function
- Host: GitHub
- URL: https://github.com/blakeembrey/is-generator
- Owner: blakeembrey
- License: mit
- Created: 2014-02-05T17:11:39.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T08:51:49.000Z (over 2 years ago)
- Last Synced: 2025-03-28T02:21:27.344Z (about 1 year ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 15
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-micro-npm-packages-zh - is-generator - 检查输入值是否是发电机函数. (模块 / Generators)
- awesome-micro-npm-packages - is-generator - Check whether a given value is a generator function. (Modules / Generators)
- fucking-awesome-micro-npm-packages - is-generator - Check whether a given value is a generator function. (Modules / Generators)
- awesome-micro-npm-packages - is-generator - Check whether a given value is a generator function. (Modules / Generators)
README
# Is Generator
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[](https://greenkeeper.io/)
> Check whether a value is a generator or generator function.
**Generator:** A specific type of iterator object. [Reference][def-gen].
**Generator Function:** A `function*` declaration, returns a generator object. [Reference][def-gen-fn].
## Installation
```
npm install is-generator --save
```
## Usage
```javascript
var isGenerator = require('is-generator')
var isGeneratorFn = require('is-generator').fn
isGenerator(null) //=> false
isGenerator(function * () {}) //=> false
isGenerator((function * () {})()) //=> true
isGeneratorFn(null) //=> false
isGeneratorFn(function () {}) //=> false
isGeneratorFn(function * () {}) //=> true
```
## License
MIT
[npm-image]: https://img.shields.io/npm/v/is-generator.svg?style=flat
[npm-url]: https://npmjs.org/package/is-generator
[downloads-image]: https://img.shields.io/npm/dm/is-generator.svg?style=flat
[downloads-url]: https://npmjs.org/package/is-generator
[travis-image]: https://img.shields.io/travis/blakeembrey/is-generator.svg?style=flat
[travis-url]: https://travis-ci.org/blakeembrey/is-generator
[coveralls-image]: https://img.shields.io/coveralls/blakeembrey/is-generator.svg?style=flat
[coveralls-url]: https://coveralls.io/r/blakeembrey/is-generator?branch=master
[def-gen]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator
[def-gen-fn]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*