time-to-botec

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

repl.txt (4289B)

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