Skip to content

Latest commit

 

History

History
291 lines (178 loc) · 8.26 KB

README.md

File metadata and controls

291 lines (178 loc) · 8.26 KB
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!

Empty Stream

NPM version Build Status Coverage Status

Create an "empty" readable stream.

Usage

import emptyStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-empty@esm/index.mjs';

You can also import the following named exports from the package:

import { factory, objectMode } from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-empty@esm/index.mjs';

emptyStream( [options] )

Returns an "empty" readable stream (i.e., a stream which never streams any values).

import inspectStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect-sink@esm/index.mjs';

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 );

emptyStream.factory( [options] )

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().


emptyStream.objectMode()

This method is a convenience function to create "empty" streams which always operate in objectMode.

import inspectStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect-sink@esm/index.mjs';

function log( v ) {
    console.log( v );
}

var stream = emptyStream.objectMode();

var opts = {
    'objectMode': true
};
var iStream = inspectStream( opts, log );

stream.pipe( iStream );

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">

import inspectStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect-sink@esm/index.mjs';
import emptyStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-empty@esm/index.mjs';

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>

See Also


Notice

This package is part of stdlib, a standard library 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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.