Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 213 Commits
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
NOTICE		NOTICE
README.md		README.md
browser.js		browser.js
browser.js.map		browser.js.map
index.js		index.js
index.js.map		index.js.map
package.json		package.json
stats_browser.html		stats_browser.html
stats_node.html		stats_node.html

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

Array Stream

Create areadable stream from an array-like object.

Usage

To use in Observable,

arrayStream=require('https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-from-array@umd/browser.js')

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

vararrayStream=require('path/to/vendor/umd/streams-node-from-array/index.js')

To include the bundle in a webpage,

<scripttype="text/javascript"src="https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-from-array@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<scripttype="text/javascript">(function(){window.arrayStream;})();</script>

arrayStream( src[, options] )

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

arrayStream.factory( [options] )

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

arrayStream.objectMode( src[, options] )

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.

Notes

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.

Examples

<!DOCTYPE html><htmllang="en"><body><scripttype="text/javascript"src="https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect-sink@umd/browser.js"></script><scripttype="text/javascript"src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@umd/browser.js"></script><scripttype="text/javascript"src="https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@umd/browser.js"></script><scripttype="text/javascript"src="https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-from-array@umd/browser.js"></script><scripttype="text/javascript">(function(){functionlog(v){console.log(v.toString());}// Create an array containing uniformly distributed pseudorandom numbers:vararr=newFloat64Array(10);vari;for(i=0;i<arr.length;i++){arr[i]=randu();}// Convert the array to a stream:varopts={'objectMode':true};varstream=arrayStream(arr,opts);// Create a writable stream for inspecting stream data:opts={'objectMode':true};variStream=inspectStream(opts,log);// Begin data flow:stream.pipe(iStream);})();</script></body></html>

Notice

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.