time-to-botec

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

index.js (3300B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Transform stream.
     23 *
     24 * @module @stdlib/streams/node/transform
     25 *
     26 * @example
     27 * var stdout = require( '@stdlib/streams/node/stdout' );
     28 * var transformStream = require( '@stdlib/streams/node/transform' );
     29 *
     30 * function transform( chunk, enc, clbk ) {
     31 *     clbk( null, chunk.toString()+'\n' );
     32 * }
     33 *
     34 * var opts = {
     35 *     'transform': transform
     36 * };
     37 * var stream = transformStream( opts );
     38 *
     39 * stream.pipe( stdout );
     40 *
     41 * stream.write( '1' );
     42 * stream.write( '2' );
     43 * stream.write( '3' );
     44 *
     45 * stream.end();
     46 * // => '1\n2\n3\n'
     47 *
     48 *
     49 * @example
     50 * var transformStream = require( '@stdlib/streams/node/transform' );
     51 *
     52 * function transform( chunk, enc, clbk ) {
     53 *     clbk( null, chunk.toString()+'\n' );
     54 * }
     55 *
     56 * var opts = {
     57 *     'objectMode': true,
     58 *     'encoding': 'utf8',
     59 *     'highWaterMark': 64,
     60 *     'decodeStrings': false
     61 * };
     62 *
     63 * var factory = transformStream.factory( opts );
     64 *
     65 * // Create 10 identically configured streams...
     66 * var streams = [];
     67 * var i;
     68 * for ( i = 0; i < 10; i++ ) {
     69 *     streams.push( factory( transform ) );
     70 * }
     71 *
     72 *
     73 * @example
     74 * var stdout = require( '@stdlib/streams/node/stdout' );
     75 * var transformStream = require( '@stdlib/streams/node/transform' );
     76 *
     77 * function stringify( chunk, enc, clbk ) {
     78 *     clbk( null, JSON.stringify( chunk ) );
     79 * }
     80 *
     81 * function newline( chunk, enc, clbk ) {
     82 *     clbk( null, chunk+'\n' );
     83 * }
     84 *
     85 * var s1 = transformStream.objectMode({
     86 *     'transform': stringify
     87 * });
     88 *
     89 * var s2 = transformStream.objectMode({
     90 *     'transform': newline
     91 * });
     92 *
     93 * s1.pipe( s2 ).pipe( stdout );
     94 *
     95 * s1.write( {'value': 'a'} );
     96 * s1.write( {'value': 'b'} );
     97 * s1.write( {'value': 'c'} );
     98 *
     99 * s1.end();
    100 * // => '{"value":"a"}\n{"value":"b"}\n{"value":"c"}\n'
    101 *
    102 *
    103 * @example
    104 * var stdout = require( '@stdlib/streams/node/stdout' );
    105 * var transformStream = require( '@stdlib/streams/node/transform' );
    106 *
    107 * function transform( chunk, enc, clbk ) {
    108 *     clbk( null, chunk.toString()+'\n' );
    109 * }
    110 *
    111 * var opts = {
    112 *     'transform': transform
    113 * };
    114 *
    115 * var Stream = transformStream.ctor( opts );
    116 *
    117 * var stream = new Stream();
    118 *
    119 * stream.pipe( stdout );
    120 *
    121 * stream.write( '1' );
    122 * stream.write( '2' );
    123 * stream.write( '3' );
    124 *
    125 * stream.end();
    126 * // => '1\n2\n3\n'
    127 */
    128 
    129 // MODULES //
    130 
    131 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
    132 var transform = require( './main.js' );
    133 var objectMode = require( './object_mode.js' );
    134 var factory = require( './factory.js' );
    135 var ctor = require( './ctor.js' );
    136 
    137 
    138 // MAIN //
    139 
    140 setReadOnly( transform, 'objectMode', objectMode );
    141 setReadOnly( transform, 'factory', factory );
    142 setReadOnly( transform, 'ctor', ctor );
    143 
    144 
    145 // EXPORTS //
    146 
    147 module.exports = transform;