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!
Usage
var circularArrayStream = require( '@stdlib/streams-node-from-circular-array' );
circularArrayStream( src[, options] )
Returns a readable stream from an array-like object which repeatedly iterates over a provided value's elements.
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
var iStream;
var stream;
var count;
function log( chunk ) {
console.log( chunk.toString() );
count += 1;
if ( count === 20 ) {
stream.destroy();
}
}
stream = circularArrayStream( [ 1, 2, 3, 4 ] );
iStream = inspectStream( log );
count = 0;
stream.pipe( iStream );
The function accepts the following options:
- objectMode: specifies whether a stream should operate in objectMode. Default:
false.
- encoding: specifies how
Buffer objects should be decoded to strings. 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 is not in objectMode. Default:
'\n'.
- serialize: custom serialization function. This option is only applicable when a stream is not in objectMode.
- iter: number of iterations. Default:
1e308.
- dir: iteration direction. If set to
-1, the stream iterates over elements from right-to-left. Default: 1.
To set stream options,
var opts = {
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64
};
var stream = circularArrayStream( [ 1, 2, 3, 4 ], opts );
By default, the returned stream is an infinite stream (i.e., never ends). To limit the number of streamed values, set the iter option.
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
function log( chunk ) {
console.log( chunk.toString() );
}
var opts = {
'iter': 10
};
var stream = circularArrayStream( [ 1, 2, 3, 4 ], opts );
var iStream = inspectStream( log );
stream.pipe( iStream );
By default, when not operating in objectMode, a returned stream delineates individual values using a newline character. To specify an alternative separator, set the sep option.
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
function log( chunk ) {
console.log( chunk.toString() );
}
var stream = circularArrayStream( [ 1, 2, 3, 4 ], {
'sep': ',',
'iter': 10
});
var iStream = inspectStream( log );
stream.pipe( iStream );
By default, when not operating in objectMode, a returned stream serializes values as JSON strings. To specify custom serialization behavior (either to a string or Buffer), set the serialize option.
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
function serialize( v ) {
return 'v::' + v.toString();
}
function log( chunk ) {
console.log( chunk.toString() );
}
var stream = circularArrayStream( [ 1, 2, 3, 4 ], {
'serialize': serialize,
'iter': 10
});
var iStream = inspectStream( log );
stream.pipe( iStream );
circularArrayStream.factory( [options] )
Returns a function for creating readable streams from array-like objects.
var opts = {
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64
};
var createStream = circularArrayStream.factory( opts );
var stream1 = createStream( [ 1, 2, 3, 4 ] );
var stream2 = createStream( [ 5, 6, 7, 8 ] );
// ...
The method accepts the same options as circularArrayStream().
circularArrayStream.objectMode( src[, options] )
This method is a convenience function to create streams which always operate in objectMode.
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
function log( v ) {
console.log( v );
}
var opts = {
'iter': 10
};
var stream = circularArrayStream.objectMode( [ 1, 2, 3, 4 ], opts );
opts = {
'objectMode': true
};
var iStream = inspectStream( opts, log );
stream.pipe( iStream );
This method accepts the same options as circularArrayStream(); however, the method will always override the objectMode option in options.
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.
