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

27 lines
442 B
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is Node stream-like.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is Node stream-like.
Examples
--------
> var Stream = require( 'stream' ).Stream;
> s = new Stream();
> var bool = {{alias}}( s )
true
> bool = {{alias}}( {} )
false
See Also
--------