Node Streams

Node.js streams.

Installation

npm install @stdlib/streams-node

Usage

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

streams

Namespace containing Node.js stream functionality.

var s = streams;
// returns {...}

The package contains the following streams:

• debugSinkStream( [options,] [clbk] ): writable stream for debugging stream pipelines.
• debugStream( [options,] [clbk] ): transform stream for debugging stream pipelines.
• emptyStream( [options] ): create an "empty" readable stream.
• arrayStream( src[, options] ): create a readable stream from an array-like object.
• circularArrayStream( src[, options] ): create a readable stream from a circular array-like object.
• constantStream( value[, options] ): create a readable stream which always streams the same value.
• iteratorStream( iterator[, options] ): create a readable stream from an iterator.
• stridedArrayStream( N, buffer, stride, offset[, options] ): create a readable stream from a strided array-like object.
• inspectSinkStream( [options,] clbk ): writable stream for inspecting streamed data.
• inspectStream( [options,] clbk ): transform stream for inspecting streamed data.
• joinStream( [options] ): transform stream which joins streamed data.
• splitStream( [options] ): transform stream which splits streamed data.
• stderr: standard error.
• stdin: standard input.
• stdout: standard output.
• transformStream( [options] ): transform stream.

Examples

var getKeys = require( '@stdlib/utils-keys' );
var streams = require( '@stdlib/streams-node' );

console.log( getKeys( streams ) );

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.