Nevertheless! Party Metaphorically

    @stdlib/assert-is-generator-object
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isGeneratorObject

    NPM version Build Status Coverage Status

    Test if a value is a generator object.

    Installation

    npm install @stdlib/assert-is-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

    See Also


    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-generator-object

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    42

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    37.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser