time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (1493B)

      1 
      2 {{alias}}( [options] )
      3     Returns an "empty" readable stream.
      4 
      5     Parameters
      6     ----------
      7     options: Object (optional)
      8         Options.
      9 
     10     options.objectMode: boolean (optional)
     11         Specifies whether a stream should operate in "objectMode". Default:
     12         false.
     13 
     14     Returns
     15     -------
     16     stream: ReadableStream
     17         Readable stream.
     18 
     19     Examples
     20     --------
     21     > function fcn( chunk ) { console.log( chunk.toString() ); };
     22     > var s = {{alias}}();
     23     > var o = {{alias:@stdlib/streams/node/inspect-sink}}( fcn );
     24     > s.pipe( o );
     25 
     26 
     27 {{alias}}.factory( [options] )
     28     Returns a function for creating empty readable streams.
     29 
     30     Parameters
     31     ----------
     32     options: Object (optional)
     33         Options.
     34 
     35     options.objectMode: boolean (optional)
     36         Specifies whether a stream should operate in "objectMode". Default:
     37         false.
     38 
     39     Returns
     40     -------
     41     fcn: Function
     42         Function for creating readable streams.
     43 
     44     Examples
     45     --------
     46     > var opts = { 'objectMode': true };
     47     > var createStream = {{alias}}.factory( opts );
     48 
     49 
     50 {{alias}}.objectMode()
     51     Returns an "objectMode" empty readable stream.
     52 
     53     Returns
     54     -------
     55     stream: ReadableStream
     56         Readable stream operating in "objectMode".
     57 
     58     Examples
     59     --------
     60     > function fcn( v ) { console.log( v ); };
     61     > var s = {{alias}}.objectMode();
     62     > var o = {{alias:@stdlib/streams/node/inspect-sink}}.objectMode( fcn );
     63     > s.pipe( o );
     64 
     65     See Also
     66     --------
     67