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

27 lines
462 B
Plaintext
Raw Normal View History

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