time-to-botec/squiggle/node_modules/@stdlib/streams/node

Node Streams

Standard library Node.js streams.

Usage

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

streams

Standard library Node.js streams.

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