github-pages-deploy-action/node_modules/is-generator-fn/readme.md
2019-11-19 07:48:29 -05:00

34 lines
645 B
Markdown

# is-generator-fn [![Build Status](https://travis-ci.org/sindresorhus/is-generator-fn.svg?branch=master)](https://travis-ci.org/sindresorhus/is-generator-fn)
> Check if something is a [generator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*)
## Install
```
$ npm install is-generator-fn
```
## Usage
```js
const isGeneratorFn = require('is-generator-fn');
isGeneratorFn(function * () {});
//=> true
isGeneratorFn(function () {});
//=> false
```
## Related
- [is](https://github.com/sindresorhus/is) - Type check values
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)