stdlib-js
<summary>
About stdlib...
</summary>
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!
Join Stream
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
[Transform stream][transform-stream] which joins streamed data.
bash
npm install @stdlib/streams-node-join
javascript
var joinStream = require( '@stdlib/streams-node-join' );
#### joinStream( [options] )
Creates a [transform stream][transform-stream] which joins streamed data.
javascript
var stdout = require( '@stdlib/streams-node-stdout' );
var stream = joinStream();
stream.pipe( stdout );
stream.write( '1' );
stream.write( '2' );
stream.write( '3' );
stream.end();
// prints: 1\n2\n3
The function accepts the following options:
- sep: separator used to join streamed data. Default: '\n'.
- objectMode: specifies whether a [stream][stream] should operate in object mode. Default: false.
- encoding: specifies how Buffer objects should be decoded to strings. Default: null.
- highWaterMark: specifies the Buffer level at which write() calls start returning false.
- allowHalfOpen: specifies whether a [stream][stream] should remain open even if one side ends. Default: false.
- readableObjectMode: specifies whether the readable side should be in object mode. Default: false.
To set [stream][stream] options,
javascript
var opts = {
'sep': ',',
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64,
'allowHalfOpen': true,
'readableObjectMode': false // overridden by `objectMode` option when `objectMode=true`
};
var stream = joinStream( opts );
#### joinStream.factory( [options] )
Returns a function for creating [streams][transform-stream] which are identically configured according to provided options.
javascript
var opts = {
'sep': '\t',
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64
};
var factory = joinStream.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 joinStream().
#### joinStream.objectMode( [options] )
This method is a convenience function to create [streams][stream] which always operate in objectMode.
javascript
var stdout = require( '@stdlib/streams-node-stdout' );
var stream = joinStream.objectMode({
'sep': ','
});
stream.pipe( stdout );
stream.write( 'a' );
stream.write( 'b' );
stream.write( 'c' );
stream.end();
// prints: a,b,c
This method accepts the same options as joinStream(); however, the method will always override the [objectMode][object-mode] option in options.
javascript
var splitStream = require( '@stdlib/streams-node-split' );
var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
var joinStream = require( '@stdlib/streams-node-join' );
var inspect;
var split;
var join;
var i;
function log( chunk ) {
console.log( chunk.toString() );
}
// Create a split stream for tab delimited data:
split = splitStream({
'sep': /\t/
});
// Create a stream to make newline delimited data:
join = joinStream({
'sep': '\n'
});
// Create a stream to inspect joined output:
inspect = inspectStream( log );
// Create a stream pipeline:
split
.pipe( join )
.pipe( inspect );
// Write values to the split stream...
for ( i = 0; i < 10; i++ ) {
split.write( i+'\t', 'utf8' );
}
split.end();
@stdlib/streams-node/split][@stdlib/streams/node/split]: transform stream which splits streamed data.
