{{alias}}( [options,] clbk ) Returns a transform stream for inspecting stream data. Parameters ---------- options: Object (optional) Options. options.objectMode: boolean (optional) Specifies whether a stream should operate in "objectMode". Default: false. options.highWaterMark: integer (optional) Specifies the maximum number of bytes to store in an internal buffer before ceasing to push downstream. options.allowHalfOpen: boolean (optional) Specifies whether a stream should remain open even if one side ends. Default: false. options.readableObjectMode: boolean (optional) Specifies whether the readable side should be in "objectMode". Default: false. clbk: Function Callback to invoke upon receiving data. Returns ------- stream: TransformStream Transform stream. Examples -------- > function clbk( chunk, idx ) { console.log( chunk.toString() ); }; > var s = {{alias}}( clbk ); > s.write( 'a' ); > s.write( 'b' ); > s.write( 'c' ); > s.end(); {{alias}}.factory( [options] ) Returns a function for creating transform streams for inspecting stream data. Parameters ---------- options: Object (optional) Options. options.objectMode: boolean (optional) Specifies whether a stream should operate in "objectMode". Default: false. options.highWaterMark: integer (optional) Specifies the maximum number of bytes to store in an internal buffer before ceasing to push downstream. options.allowHalfOpen: boolean (optional) Specifies whether a stream should remain open even if one side ends. Default: false. options.readableObjectMode: boolean (optional) Specifies whether the readable side should be in "objectMode". Default: false. Returns ------- createStream( clbk ): Function Function for creating transform streams. Examples -------- > var opts = { 'objectMode': true, 'highWaterMark': 64 }; > var createStream = {{alias}}.factory( opts ); > function clbk( chunk, idx ) { console.log( chunk.toString() ); }; > var s = createStream( clbk ); > s.write( 'a' ); > s.write( 'b' ); > s.write( 'c' ); > s.end(); {{alias}}.objectMode( [options,] clbk ) Returns an "objectMode" transform stream for inspecting stream data. Parameters ---------- options: Object (optional) Options. options.highWaterMark: integer (optional) Specifies the maximum number of objects to store in an internal buffer before ceasing to push downstream. options.allowHalfOpen: boolean (optional) Specifies whether a stream should remain open even if one side ends. Default: false. options.readableObjectMode: boolean (optional) Specifies whether the readable side should be in "objectMode". Default: false. clbk: Function Callback to invoke upon receiving data. Returns ------- stream: TransformStream Transform stream operating in "objectMode". Examples -------- > function clbk( chunk, idx ) { console.log( chunk.toString() ); }; > var s = {{alias}}.objectMode( clbk ); > s.write( { 'value': 'a' } ); > s.write( { 'value': 'b' } ); > s.write( { 'value': 'c' } ); > s.end(); See Also --------