time-to-botec/squiggle/node_modules/@stdlib/assert/is-generator-object/README.md

isGeneratorObject

Test if a value is a generator object.

Usage

var isGeneratorObject = require( '@stdlib/assert/is-generator-object' );

isGeneratorObject( value )

Tests if a value is a generator object.

function* generateID() {
    var idx = 0;
    while ( idx < idx+1 ) {
        yield idx;
        idx += 1;
    }
}

var bool = isGeneratorObject( generateID() );
// returns true

bool = isGeneratorObject( generateID );
// returns false

bool = isGeneratorObject( {} );
// returns false

Examples

var isGeneratorObject = require( '@stdlib/assert/is-generator-object' );

function* generator() {
    while ( true ) {
        yield 1.0;
    }
}

var bool = isGeneratorObject( generator() );
// returns true

bool = isGeneratorObject( {} );
// returns false

bool = isGeneratorObject( [] );
// returns false

bool = isGeneratorObject( null );
// returns false