time-to-botec

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

factory.js (2579B)

      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 Stream = require( './main.js' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Creates a reusable inspect stream factory.
     32 *
     33 * @param {Options} [options] - stream options
     34 * @param {boolean} [options.objectMode=false] - specifies whether the stream should operate in object mode
     35 * @param {NonNegativeNumber} [options.highWaterMark] - specifies the `Buffer` level for when `write()` starts returning `false`
     36 * @param {boolean} [options.allowHalfOpen=false] - specifies whether the stream should remain open even if one side ends
     37 * @param {boolean} [options.readableObjectMode=false] - specifies whether the readable side should be in object mode
     38 * @throws {TypeError} options argument must be an object
     39 * @returns {Function} inspect stream factory
     40 *
     41 * @example
     42 * function log( chunk, idx ) {
     43 *     console.log( 'index: %d', idx );
     44 *     console.log( chunk );
     45 * }
     46 *
     47 * var opts = {
     48 *     'objectMode': true,
     49 *     'highWaterMark': 64
     50 * };
     51 *
     52 * var factory = streamFactory( opts );
     53 *
     54 * // Create 10 identically configured streams...
     55 * var streams = [];
     56 * var i;
     57 * for ( i = 0; i < 10; i++ ) {
     58 *     streams.push( factory( log ) );
     59 * }
     60 */
     61 function streamFactory( options ) {
     62 	var opts;
     63 	if ( arguments.length ) {
     64 		if ( !isObject( options ) ) {
     65 			throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
     66 		}
     67 		opts = copy( options );
     68 	} else {
     69 		opts = {};
     70 	}
     71 	return inspectStream;
     72 
     73 	/**
     74 	* Creates a transform stream for inspecting streamed data.
     75 	*
     76 	* @private
     77 	* @param {Callback} clbk - callback to invoke upon receiving data
     78 	* @throws {TypeError} must provide valid options
     79 	* @throws {TypeError} must provide a callback function
     80 	* @returns {InspectStream} inspect stream
     81 	*/
     82 	function inspectStream( clbk ) {
     83 		return new Stream( opts, clbk );
     84 	}
     85 }
     86 
     87 
     88 // EXPORTS //
     89 
     90 module.exports = streamFactory;