time-to-botec/squiggle/node_modules/@stdlib/assert/is-generator-object-like/docs/repl.txt

32 lines
575 B
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is generator object-like.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is generator object-like.
Examples
--------
> var obj = {
... 'next': function noop() {},
... 'return': function noop() {},
... 'throw': function noop() {}
... };
> var bool = {{alias}}( obj )
true
> bool = {{alias}}( {} )
false
> bool = {{alias}}( null )
false
See Also
--------