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!
Transform stream which splits streamed data.
npm install @stdlib/streams-node-split
var splitStream = require( '@stdlib/streams-node-split' );
Creates a transform stream which splits streamed data.
var stdout = require( '@stdlib/streams-node-stdout' );
var stream = splitStream();
stream.pipe( stdout );
stream.write( '1\n2\n3' );
stream.end();
// prints: 1 => 2 => 3
The function accepts the following options
:
-
sep: separator used to split streamed data. Similar to
String#split
, a separator may be either a regular expression or astring
. Default:/\r?\n/
. -
objectMode: specifies whether a stream should operate in objectMode. Default:
false
. -
encoding: specifies how
Buffer
objects should be decoded tostrings
. Default:null
. -
highWaterMark: specifies the
Buffer
level at whichwrite()
calls start returningfalse
. -
allowHalfOpen: specifies whether a stream should remain open even if one side ends. Default:
false
. -
writableObjectMode: specifies whether the writable side should be in objectMode. Default:
false
.
To set stream options
,
var opts = {
'sep': ',',
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64,
'allowHalfOpen': true,
'writableObjectMode': false // overridden by `objectMode` option when `objectMode=true`
};
var stream = splitStream( opts );
Returns a function
for creating streams which are identically configured according to provided options
.
var opts = {
'sep': '\t',
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64
};
var factory = splitStream.factory( opts );
// Create 10 identically configured streams...
var streams = [];
var i;
for ( i = 0; i < 10; i++ ) {
streams.push( factory() );
}
This method accepts the same options
as splitStream()
.
This method is a convenience function to create streams which always operate in objectMode.
var stdout = require( '@stdlib/streams-node-stdout' );
var stream = splitStream.objectMode({
'sep': ','
});
stream.pipe( stdout );
stream.write( 'a,b,c' );
stream.end();
// prints: a => b => c
This method accepts the same options
as splitStream()
; however, the method will always override the objectMode option in options
.
-
Similar to
String#split
, a separator which is a regular expression containing a matching group will result in the separator being retained in the output stream.var stdout = require( '@stdlib/streams-node-stdout' ); var stream = splitStream({ 'sep': /(,)/ }); stream.pipe( stdout ); stream.write( '1,2,3' ); stream.end(); // prints: 1 => , => 2 => , => 3
var transformStream = require( '@stdlib/streams-node-transform' );
var stdout = require( '@stdlib/streams-node-stdout' );
var splitStream = require( '@stdlib/streams-node-split' );
function append( chunk, enc, clbk ) {
clbk( null, chunk.toString()+'\n' );
}
var newline;
var stream;
var i;
// Create a split stream to split tab delimited data:
stream = splitStream({
'sep': /\t/
});
// Create a transform stream to make newline delimited data...
newline = transformStream({
'transform': append,
'objectMode': true
});
// Create a stream pipeline:
stream
.pipe( newline )
.pipe( stdout );
// Write data to the pipeline...
for ( i = 0; i < 10; i++ ) {
stream.write( i+'\t', 'utf8' );
}
stream.end();
-
@stdlib/streams-node/join
: transform stream which joins streamed data.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.