time-to-botec

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

index.js (2008B)

      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 * Writable stream for debugging stream pipelines.
     23 *
     24 * @module @stdlib/streams/node/debug-sink
     25 *
     26 * @example
     27 * var debugSinkStream = require( '@stdlib/streams/node/debug-sink' );
     28 *
     29 * var stream = debugSinkStream({
     30 *     'name': 'my-stream'
     31 * });
     32 *
     33 * stream.write( 'a' );
     34 * stream.write( 'b' );
     35 * stream.write( 'c' );
     36 * stream.end();
     37 *
     38 * @example
     39 * var debugSinkStream = require( '@stdlib/streams/node/debug-sink' );
     40 *
     41 * var stream = debugSinkStream.objectMode({
     42 *     'name': 'my-stream'
     43 * });
     44 *
     45 * stream.write( {'value': 'a'} );
     46 * stream.write( {'value': 'b'} );
     47 * stream.write( {'value': 'c'} );
     48 * stream.end();
     49 *
     50 * @example
     51 * var debugSinkStream = require( '@stdlib/streams/node/debug-sink' );
     52 *
     53 * var opts = {
     54 *     'objectMode': true,
     55 *     'highWaterMark': 64
     56 * };
     57 *
     58 * var factory = debugSinkStream.factory( opts );
     59 *
     60 * // Assign each stream to a separate 'debug' namespace...
     61 * var streams = [];
     62 * var i;
     63 * for ( i = 0; i < 10; i++ ) {
     64 *     streams.push( factory( 'stream '+i ) );
     65 * }
     66 */
     67 
     68 
     69 // MODULES //
     70 
     71 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     72 var stream = require( './main.js' );
     73 var objectMode = require( './object_mode.js' );
     74 var factory = require( './factory.js' );
     75 
     76 
     77 // MAIN //
     78 
     79 setReadOnly( stream, 'objectMode', objectMode );
     80 setReadOnly( stream, 'factory', factory );
     81 
     82 
     83 // EXPORTS //
     84 
     85 module.exports = stream;