time-to-botec/js/node_modules/@stdlib/streams/node/debug-sink/docs/repl.txt

129 lines
3.5 KiB
Plaintext
Raw Normal View History

{{alias}}( [options,] [clbk] )
Returns a writable stream for debugging stream pipelines.
If the `DEBUG` environment variable is not set, no data is logged.
Providing a `name` option is *strongly* encouraged, as the `DEBUG`
environment variable can be used to filter debuggers.
Parameters
----------
options: Object (optional)
Options.
options.name: string (optional)
Debug namespace.
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.decodeStrings: boolean (optional)
Specifies whether to encode strings as `Buffer` objects before writing
data to a returned stream. Default: true.
options.defaultEncoding: string (optional)
Default encoding when not explicitly specified when writing data.
Default: 'utf8'.
clbk: Function (optional)
Callback to invoke upon receiving data.
Returns
-------
stream: WritableStream
Writable stream.
Examples
--------
> var s = {{alias}}( { 'name': 'foo' } );
> s.write( 'a' );
> s.write( 'b' );
> s.write( 'c' );
> s.end();
{{alias}}.factory( [options] )
Returns a function for creating writable streams for debugging stream
pipelines.
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.decodeStrings: boolean (optional)
Specifies whether to encode strings as `Buffer` objects before writing
data to a returned stream. Default: true.
options.defaultEncoding: string (optional)
Default encoding when not explicitly specified when writing data.
Default: 'utf8'.
Returns
-------
createStream( name[, clbk] ): Function
Function for creating writable streams.
Examples
--------
> var opts = { 'objectMode': true, 'highWaterMark': 64 };
> var createStream = {{alias}}.factory( opts );
{{alias}}.objectMode( [options,] [clbk] )
Returns an "objectMode" writable stream for debugging stream pipelines.
Parameters
----------
options: Object (optional)
Options.
options.name: string (optional)
Debug namespace.
options.highWaterMark: integer (optional)
Specifies the maximum number of objects to store in an internal buffer
before ceasing to push downstream.
options.decodeStrings: boolean (optional)
Specifies whether to encode strings as `Buffer` objects before writing
data to a returned stream. Default: true.
options.defaultEncoding: string (optional)
Default encoding when not explicitly specified when writing data.
Default: 'utf8'.
clbk: Function (optional)
Callback to invoke upon receiving data.
Returns
-------
stream: WritableStream
Writable stream operating in "objectMode".
Examples
--------
> var s = {{alias}}.objectMode( { 'name': 'foo' } );
> s.write( { 'value': 'a' } );
> s.write( { 'value': 'b' } );
> s.write( { 'value': 'c' } );
> s.end();
See Also
--------