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!
Create an "empty" readable stream.
To use in Observable,
emptyStream = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-empty@umd/browser.js' )To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:
var emptyStream = require( 'path/to/vendor/umd/streams-node-empty/index.js' )To include the bundle in a webpage,
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-empty@umd/browser.js"></script>If no recognized module system is present, access bundle contents via the global scope:
<script type="text/javascript">
(function () {
window.emptyStream;
})();
</script>Returns an "empty" readable stream (i.e., a stream which never streams any values).
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
function log( chunk ) {
// This function should never be called...
console.log( chunk.toString() );
}
var stream = emptyStream();
var iStream = inspectStream( log );
stream.pipe( iStream );The function accepts the following options:
- objectMode: specifies whether a stream should operate in objectMode. Default:
false.
To set stream options,
var opts = {
'objectMode': true
};
var stream = emptyStream( opts );Returns a function for creating "empty" readable streams.
var opts = {
'objectMode': true
};
var createStream = emptyStream.factory( opts );
var stream1 = createStream();
var stream2 = createStream();
// ...The method accepts the same options as emptyStream().
This method is a convenience function to create "empty" streams which always operate in objectMode.
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
function log( v ) {
console.log( v );
}
var stream = emptyStream.objectMode();
var opts = {
'objectMode': true
};
var iStream = inspectStream( opts, log );
stream.pipe( iStream );<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect-sink@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-empty@umd/browser.js"></script>
<script type="text/javascript">
(function () {
function log( v ) {
console.log( v.toString() );
}
var opts = {
'objectMode': true
};
var stream = emptyStream( opts );
opts = {
'objectMode': true
};
var iStream = inspectStream( opts, log );
stream.pipe( iStream );
})();
</script>
</body>
</html>@stdlib/streams-node/from-constant: create a readable stream which always streams the same value.
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.