# is-generator

> Check whether a value is a generator or generator function

Latest version **1.0.3** (published 2016-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-generator
pnpm add is-generator
yarn add is-generator
bun add is-generator
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2016-03-29 |
| First published | 2014-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/is-generator) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Blake Embrey |
| Maintainers | blakeembrey |
| Keywords | generator, generator function, yield, function, await, es6, function* |

## Links

- npm: https://www.npmjs.com/package/is-generator
- Repository: https://github.com/blakeembrey/is-generator
- Issues: https://github.com/blakeembrey/is-generator/issues
- npm.io page: https://npm.io/package/is-generator

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2016-03-29
- 1.0.2 — 2015-05-25
- 1.0.1 — 2015-05-25
- 1.0.0 — 2014-08-17
- 0.0.4 — 2014-05-04
- 0.0.3 — 2014-02-13
- 0.0.2 — 2014-02-13
- 0.0.1 — 2014-02-05

## 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]

> 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*

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