Skip to content

Check whether a value is a generator or generator function. The `co()` way, more strict checking. Always return boolean true or false, never null or undefined.

License

Notifications You must be signed in to change notification settings

tunnckoCore/is-es6-generators

Repository files navigation

is-es6-generators npmjs.com The MIT License

Check whether a value is a Generator or GeneratorFunction. The co() way, more strict checking. Always return boolean true or false, never null or undefined.

code climate standard code style travis build status coverage status dependency status

Install

npm i is-es6-generators --save
npm test

Usage

For more use-cases see the tests

var isGenerator = require('is-es6-generators')
var isGeneratorFunction = require('is-es6-generators').fn

var generator = (function * () {})()
var generatorFunction = function * () {yield 42}

isGenerator(null) //=> false
isGenerator(undefined) //=> false
isGenerator([1, 2, 3]) //=> false
isGenerator({name: 'GeneratorFunction'}) //=> false
isGenerator(25) //=> false
isGenerator('test') //=> false
isGenerator(generatorFunction) //=> false
isGenerator(generator), true)

isGeneratorFunction(null) //=> false
isGeneratorFunction(generatorFunction) //=> true
isGeneratorFunction(generator) //=> false

See also

  • apidocs-cli: Async CLI for automatically generating API docs from code comments
  • is-es6-generator: Check that given value is Generator
  • is-es6-generator-function: Check that given value is GeneratorFunction
  • is-generator-function-name: Check that given value have GeneratorFunction name… more.
  • is-generator-function: Determine if a function is an ES6 generator function or not.
  • is-generator: Check whether a value is a generator or generator function
  • is-hybrid: Check whether an object looks like Hybrid which is promises-a+ promise and callback api
  • is-promise: Test whether an object looks like a promises-a+ promise
  • is-missing: Check that given name or user/repo exists in npm registry or in github as… more
  • is-installed: Checks that given package is installed on the system - globally or locally.
  • is-kindof: Check type of given javascript value. Support promises, generators, streams, and native types. Thin wrapper around kind-of module.
  • npm-related: Thin wrapper on top of helper-related for generating a list of links to the… more

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

tunnckocore.tk keybase tunnckocore tunnckoCore npm tunnckoCore twitter tunnckoCore github

About

Check whether a value is a generator or generator function. The `co()` way, more strict checking. Always return boolean true or false, never null or undefined.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published