time-to-botec

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

object_mode.js (1164B)

      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 // MODULES //
     22 
     23 var EmptyStream = require( './main.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Returns an "objectMode" empty readable stream.
     30 *
     31 * @returns {EmptyStream} Stream instance
     32 *
     33 * @example
     34 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     35 *
     36 * function log( v ) {
     37 *    console.log( v );
     38 * }
     39 *
     40 * var stream = objectMode();
     41 *
     42 * stream.pipe( inspectStream.objectMode( log ) );
     43 */
     44 function objectMode() {
     45 	var opts = {
     46 		'objectMode': true
     47 	};
     48 	return new EmptyStream( opts );
     49 }
     50 
     51 
     52 // EXPORTS //
     53 
     54 module.exports = objectMode;