About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Readable Stream-like
Test if a value is Node readable stream-like.
Installation
npm install @stdlib/assert-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
Notice
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
