npm install @stdlib/streams-node-from-array

Alternatively,

• To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
• If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
• For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

vararrayStream=require('@stdlib/streams-node-from-array');

Returns areadable stream from an array-likeobject.

varinspectStream=require('@stdlib/streams-node-inspect-sink');functionlog(chunk){console.log(chunk.toString());}varstream=arrayStream([1,2,3,4]);variStream=inspectStream(log);stream.pipe(iStream);

The function accepts the followingoptions:

• objectMode: specifies whether astream should operate inobjectMode. Default:false.
• encoding: specifies howBuffer objects should be decoded tostrings. Default:null.
• highWaterMark: specifies the maximum number of bytes to store in an internal buffer before pausing streaming.
• sep: separator used to join streamed data. This option is only applicable when a stream isnot inobjectMode. Default:'\n'.
• serialize: custom serialization function. This option is only applicable when a stream isnot inobjectMode.
• dir: iteration direction. If set to-1, the stream iterates over elements from right-to-left. Default:1.

To setstreamoptions,

varopts={'objectMode':true,'encoding':'utf8','highWaterMark':64};varstream=arrayStream([1,2,3,4],opts);

By default, when not operating inobjectMode, a returnedstream delineates individual values using a newline character. To specify an alternative separator, set thesep option.

varinspectStream=require('@stdlib/streams-node-inspect-sink');functionlog(chunk){console.log(chunk.toString());}varstream=arrayStream([1,2,3,4],{'sep':','});variStream=inspectStream(log);stream.pipe(iStream);

By default, when not operating inobjectMode, a returnedstream serializes values as JSON strings. To specify custom serialization behavior (either to astring orBuffer), set theserialize option.

varinspectStream=require('@stdlib/streams-node-inspect-sink');functionserialize(v){return'v::'+v.toString();}functionlog(chunk){console.log(chunk.toString());}varstream=arrayStream([1,2,3,4],{'serialize':serialize});variStream=inspectStream(log);stream.pipe(iStream);

Returns afunction for creatingreadable streams from array-like objects.

varopts={'objectMode':true,'encoding':'utf8','highWaterMark':64};varcreateStream=arrayStream.factory(opts);varstream1=createStream([1,2,3,4]);varstream2=createStream([5,6,7,8]);// ...

The method accepts the sameoptions asarrayStream().

This method is a convenience function to createstreams whichalways operate inobjectMode.

varinspectStream=require('@stdlib/streams-node-inspect-sink');functionlog(v){console.log(v);}varstream=arrayStream.objectMode([1,2,3,4]);varopts={'objectMode':true};variStream=inspectStream(opts,log);stream.pipe(iStream);

This method accepts the sameoptions asarrayStream(); however, the method willalways override theobjectMode option inoptions.

• InobjectMode,null is a reserved value. If anarray containsnull values (e.g., as a means to encode missing values), the stream will prematurely end. Consider an alternative encoding or filternull values prior to invocation.
• In binary mode, if anarray containsundefined values, the stream will emit an error. Consider providing a custom serialization function or filteringundefined values prior to invocation.

• @stdlib/streams-node/from-circular-array:create a readable stream from a circular array-like object.
• @stdlib/streams-node/from-iterator:create a readable stream from an iterator.
• @stdlib/streams-node/from-strided-array:create a readable stream from a strided array-like object.

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.

SeeLICENSE.

Copyright © 2016-2025. The StdlibAuthors.