Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

detect-generator-support

planeshifter14MIT1.0.2

Detect native generator function support.

utilities, utility, utils, util, detect, feature, generator, generator function, yield, es2015, es6, support, has, hasgenerator, hasgenerators, native, issupported, cli

readme

Generator Support

NPM version Build Status Coverage Status Dependencies

Detect native generator function support.

Installation

$ npm install detect-generator-support

Usage

var areGeneratorsSupported = require( 'detect-generator-support' );

areGeneratorsSupported()

Detects if a runtime environment supports ES2015 generator functions, i.e. function*().

var bool = areGeneratorsSupported();
// returns <Boolean>

Examples

var areGeneratorsSupported = require( 'detect-generator-support' );

var bool = areGeneratorsSupported();
if ( bool ) {
    console.log( 'Environment has native generator function support.' );
} else {
    console.log( 'Environment lacks native generator function support.' );
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

CLI

Installation

To use the module as a general utility, install the module globally

$ npm install -g detect-generator-support

Usage

Usage: hasgenerators [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ hasgenerators
# => returns 'true' || 'false'

Tests

Unit

This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

Browser Support

This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

$ make test-browsers

To view the tests in a local web browser,

$ make view-browser-tests

License

MIT license.

Copyright © 2016. Philipp Burckhardt.