Test if a value is Node stream-like.
APACHE-2.0 License
Test if a value is Node stream-like.
npm install @stdlib/assert-is-node-stream-like
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var isNodeStreamLike = require( '@stdlib/assert-is-node-stream-like' );
Tests if a value
is Node stream-like.
var transformStream = require( '@stdlib/streams-node-transform' );
var bool = isNodeStreamLike( transformStream() );
// returns true
var stream = require( 'stream' );
var transformStream = require( '@stdlib/streams-node-transform' );
var isNodeStreamLike = require( '@stdlib/assert-is-node-stream-like' );
var bool = isNodeStreamLike( new stream.Stream() );
// returns true
bool = isNodeStreamLike( new stream.Readable() );
// returns true
bool = isNodeStreamLike( new stream.Writable() );
// returns true
bool = isNodeStreamLike( new stream.Duplex() );
// returns true
bool = isNodeStreamLike( new stream.Transform() );
// returns true
bool = isNodeStreamLike( transformStream() );
// returns true
bool = isNodeStreamLike( {} );
// returns false
bool = isNodeStreamLike( [] );
// returns false
bool = isNodeStreamLike( null );
// returns false
function Stream() {
return this;
}
bool = isNodeStreamLike( Stream );
// returns false
bool = isNodeStreamLike( new Stream() );
// returns false
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.