time-to-botec/squiggle/node_modules/@stdlib/assert/is-node-readable-stream-like/README.md

Readable Stream-like

Test if a value is Node readable stream-like.

Usage

var isNodeReadableStreamLike = require( '@stdlib/assert/is-node-readable-stream-like' );

isNodeReadableStreamLike( value )

Tests if a value is Node readable stream-like.

var transformStream = require( '@stdlib/streams/node/transform' );

var bool = isNodeReadableStreamLike( transformStream() );
// returns true

Examples

var stream = require( 'stream' );
var transformStream = require( '@stdlib/streams/node/transform' );
var isNodeReadableStreamLike = require( '@stdlib/assert/is-node-readable-stream-like' );

var bool = isNodeReadableStreamLike( new stream.Readable() );
// returns true

bool = isNodeReadableStreamLike( new stream.Duplex() );
// returns true

bool = isNodeReadableStreamLike( new stream.Transform() );
// returns true

bool = isNodeReadableStreamLike( transformStream() );
// returns true

bool = isNodeReadableStreamLike( new stream.Writable() );
// returns false

bool = isNodeReadableStreamLike( new stream.Stream() );
// returns false

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

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

bool = isNodeReadableStreamLike( null );
// returns false

function Stream() {
    return this;
}

bool = isNodeReadableStreamLike( Stream );
// returns false

bool = isNodeReadableStreamLike( new Stream() );
// returns false