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 joins streamed data.
import joinStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-join@deno/mod.js';
You can also import the following named exports from the package:
import { factory, objectMode } from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-join@deno/mod.js';
Creates a transform stream which joins streamed data.
import stdout from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-stdout@deno/mod.js';
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 should operate in object mode. 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
. - readableObjectMode: specifies whether the readable side should be in object mode. Default:
false
.
To set stream options
,
var opts = {
'sep': ',',
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 64,
'allowHalfOpen': true,
'readableObjectMode': false // overridden by `objectMode` option when `objectMode=true`
};
var stream = joinStream( 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 = 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()
.
This method is a convenience function to create streams which always operate in objectMode
.
import stdout from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-stdout@deno/mod.js';
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 option in options
.
import splitStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-split@deno/mod.js';
import inspectStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect-sink@deno/mod.js';
import joinStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-join@deno/mod.js';
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
: transform stream which splits streamed data.
This package is part of stdlib, a standard library 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.