time-to-botec

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

repl.txt (3762B)

      1 
      2 {{alias}}( [options] )
      3     Returns a transform stream which joins streamed data.
      4 
      5     Parameters
      6     ----------
      7     options: Object (optional)
      8         Options.
      9 
     10     options.sep: string (optional)
     11         Separator used to join streamed data. Default: '\n'.
     12 
     13     options.objectMode: boolean (optional)
     14         Specifies whether a stream should operate in "objectMode". Default:
     15         false.
     16 
     17     options.encoding: string|null (optional)
     18         Specifies how Buffer objects should be decoded to strings. Default:
     19         null.
     20 
     21     options.highWaterMark: integer (optional)
     22         Specifies the maximum number of bytes to store in an internal buffer
     23         before ceasing to push downstream.
     24 
     25     options.allowHalfOpen: boolean (optional)
     26         Specifies whether a stream should remain open even if one side ends.
     27         Default: false.
     28 
     29     options.readableObjectMode: boolean (optional)
     30         Specifies whether the readable side should be in "objectMode". Default:
     31         false.
     32 
     33     Returns
     34     -------
     35     stream: TransformStream
     36         Transform stream.
     37 
     38     Examples
     39     --------
     40     > var s = {{alias}}();
     41     > s.write( 'a' );
     42     > s.write( 'b' );
     43     > s.write( 'c' );
     44     > s.end();
     45 
     46 
     47 {{alias}}.factory( [options] )
     48     Returns a function for creating transform streams for joined streamed data.
     49 
     50     Parameters
     51     ----------
     52     options: Object (optional)
     53         Options.
     54 
     55     options.sep: string (optional)
     56         Separator used to join streamed data. Default: '\n'.
     57 
     58     options.objectMode: boolean (optional)
     59         Specifies whether a stream should operate in "objectMode". Default:
     60         false.
     61 
     62     options.encoding: string|null (optional)
     63         Specifies how Buffer objects should be decoded to strings. Default:
     64         null.
     65 
     66     options.highWaterMark: integer (optional)
     67         Specifies the maximum number of bytes to store in an internal buffer
     68         before ceasing to push downstream.
     69 
     70     options.allowHalfOpen: boolean (optional)
     71         Specifies whether a stream should remain open even if one side ends.
     72         Default: false.
     73 
     74     options.readableObjectMode: boolean (optional)
     75         Specifies whether the readable side should be in "objectMode". Default:
     76         false.
     77 
     78     Returns
     79     -------
     80     createStream: Function
     81         Function for creating transform streams.
     82 
     83     Examples
     84     --------
     85     > var opts = { 'highWaterMark': 64 };
     86     > var createStream = {{alias}}.factory( opts );
     87     > var s = createStream();
     88     > s.write( 'a' );
     89     > s.write( 'b' );
     90     > s.write( 'c' );
     91     > s.end();
     92 
     93 
     94 {{alias}}.objectMode( [options] )
     95     Returns an "objectMode" transform stream for joining streamed data.
     96 
     97     Parameters
     98     ----------
     99     options: Object (optional)
    100         Options.
    101 
    102     options.sep: string (optional)
    103         Separator used to join streamed data. Default: '\n'.
    104 
    105     options.encoding: string|null (optional)
    106         Specifies how Buffer objects should be decoded to strings. Default:
    107         null.
    108 
    109     options.highWaterMark: integer (optional)
    110         Specifies the maximum number of objects to store in an internal buffer
    111         before ceasing to push downstream.
    112 
    113     options.allowHalfOpen: boolean (optional)
    114         Specifies whether a stream should remain open even if one side ends.
    115         Default: false.
    116 
    117     options.readableObjectMode: boolean (optional)
    118         Specifies whether the readable side should be in "objectMode". Default:
    119         false.
    120 
    121     Returns
    122     -------
    123     stream: TransformStream
    124         Transform stream operating in "objectMode".
    125 
    126     Examples
    127     --------
    128     > var s = {{alias}}.objectMode();
    129     > s.write( { 'value': 'a' } );
    130     > s.write( { 'value': 'b' } );
    131     > s.write( { 'value': 'c' } );
    132     > s.end();
    133 
    134     See Also
    135     --------
    136