isGeneratorObjectLike

Test if a value is generator object-like.

Installation

npm install @stdlib/assert-is-generator-object-like

Usage

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

isGeneratorObjectLike( value )

Tests if a value is generator object-like.

var obj = {
    'next': function noop() {},
    'return': function noop() {},
    'throw': function noop() {}
};
var bool = isGeneratorObjectLike( obj );
// returns true

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

Examples

var noop = require( '@stdlib/utils-noop' );
var isGeneratorObjectLike = require( '@stdlib/assert-is-generator-object-like' );

var obj = {
    'next': noop,
    'return': noop,
    'throw': noop
};
var bool = isGeneratorObjectLike( obj );
// returns true

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

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

bool = isGeneratorObjectLike( null );
// returns false

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.

License

See LICENSE.

@stdlib/assert-is-generator-object-like

Package Exports

Readme