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 for inspecting streamed data.
import inspectStream from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect@esm/index.mjs';You can also import the following named exports from the package:
import { factory, objectMode } from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect@esm/index.mjs';Creates a transform stream for inspecting streamed data.
function log( chunk, idx ) {
console.log( 'index: %d', idx );
console.log( chunk );
}
var stream = inspectStream( log );
stream.write( 'a' );
stream.write( 'b' );
stream.write( 'c' );
stream.end();
/* =>
'index: 0'
'a'
'index: 1'
'b'
'index: 2'
'c'
*/The function accepts the following options:
- objectMode: specifies whether a stream should operate in objectMode. Default:
false. - highWaterMark: specifies the
Bufferlevel 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 objectMode. Default:
false.
To set stream options,
function log( chunk, idx ) {
console.log( 'index: %d', idx );
console.log( chunk );
}
var opts = {
'objectMode': true,
'highWaterMark': 64,
'allowHalfOpen': true,
'readableObjectMode': false // overridden by `objectMode` option when `objectMode=true`
};
var stream = inspectStream( opts, log );Returns a function for creating streams which are identically configured according to provided options.
var opts = {
'objectMode': true,
'highWaterMark': 64
};
var factory = inspectStream.factory( opts );This method accepts the same options as inspectStream().
Creates a transform stream for inspecting streamed data.
function log( chunk, idx ) {
console.log( 'index: %d', idx );
console.log( chunk );
}
var factory = inspectStream.factory();
// Create 10 identically configured streams...
var streams = [];
var i;
for ( i = 0; i < 10; i++ ) {
streams.push( factory( log ) );
}This method is a convenience function to create streams which always operate in objectMode.
function log( chunk, idx ) {
console.log( 'index: %d', idx );
console.log( chunk );
}
var stream = inspectStream.objectMode( log );
stream.write( { 'value': 'a' } );
stream.write( { 'value': 'b' } );
stream.write( { 'value': 'c' } );
stream.end();
/* =>
'index: 0'
{'value': 'a'}
'index: 1'
{'value': 'b'}
'index: 2'
{'value': 'c'}
*/This method accepts the same options as inspectStream(); however, the method will always override the objectMode option in options.
<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">
import parseJSON from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-parse-json@esm/index.mjs';
import stdout from 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-stdout@esm/index.mjs';
var transformFactory = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-transform' ).factory;
var inspect = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/streams-node-inspect' ).objectMode;
function parse( chunk, enc, clbk ) {
clbk( null, parseJSON( chunk ) );
}
function pluck( chunk, enc, clbk ) {
clbk( null, chunk.value );
}
function square( chunk, enc, clbk ) {
var v = +chunk;
clbk( null, v*v );
}
function toStr( chunk, enc, clbk ) {
clbk( null, chunk.toString() );
}
function join( chunk, enc, clbk ) {
clbk( null, chunk+'\n' );
}
function logger( name ) {
return log;
function log( chunk, idx ) {
console.log( 'name: %s', name );
console.log( 'index: %d', idx );
console.log( chunk );
}
}
// Create a factory for generating streams running in `objectMode`:
var tStream = transformFactory({
'objectMode': true
});
// Create streams for each transform:
var s1 = tStream( parse );
var i1 = inspect( logger( 'parse' ) );
var s2 = tStream( pluck );
var i2 = inspect( logger( 'pluck' ) );
var s3 = tStream( square );
var i3 = inspect( logger( 'square' ) );
var s4 = tStream( toStr );
var i4 = inspect( logger( 'toString' ) );
var s5 = tStream( join );
var i5 = inspect( logger( 'join' ) );
// Create the pipeline:
s1.pipe( i1 )
.pipe( s2 )
.pipe( i2 )
.pipe( s3 )
.pipe( i3 )
.pipe( s4 )
.pipe( i4 )
.pipe( s5 )
.pipe( i5 )
.pipe( stdout );
// Write data to the pipeline...
var v;
var i;
for ( i = 0; i < 100; i++ ) {
v = '{"value":'+i+'}';
s1.write( v, 'utf8' );
}
s1.end();
</script>
</body>
</html>@stdlib/streams-node/debug: transform stream for debugging stream pipelines.
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.