time-to-botec

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

object_mode.js (2133B)

      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 isObject = require( '@stdlib/assert/is-plain-object' );
     24 var copy = require( '@stdlib/utils/copy' );
     25 var ConstantStream = require( './main.js' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Returns an "objectMode" readable stream which always streams the same value.
     32 *
     33 * @param {*} value - value to stream
     34 * @param {Options} [options] - stream options
     35 * @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to `strings`
     36 * @param {NonNegativeNumber} [options.highWaterMark] - specifies the maximum number of objects to store in an internal buffer before pausing streaming
     37 * @param {NonNegativeInteger} [options.iter] - number of iterations
     38 * @throws {TypeError} options argument must be an object
     39 * @throws {TypeError} must provide valid options
     40 * @returns {ConstantStream} Stream instance
     41 *
     42 * @example
     43 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     44 *
     45 * function log( v ) {
     46 *    console.log( v );
     47 * }
     48 *
     49 * var opts = {
     50 *     'iter': 10
     51 * };
     52 *
     53 * var stream = objectMode( 3.14, opts );
     54 *
     55 * stream.pipe( inspectStream.objectMode( log ) );
     56 */
     57 function objectMode( value, options ) {
     58 	var opts;
     59 	if ( arguments.length > 1 ) {
     60 		opts = options;
     61 		if ( !isObject( opts ) ) {
     62 			throw new TypeError( 'invalid argument. Options must be an object. Value: `' + opts + '`.' );
     63 		}
     64 		opts = copy( options, 1 );
     65 	} else {
     66 		opts = {};
     67 	}
     68 	opts.objectMode = true;
     69 	return new ConstantStream( value, opts );
     70 }
     71 
     72 
     73 // EXPORTS //
     74 
     75 module.exports = objectMode;