time-to-botec

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

object_mode.js (2341B)

      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 * Returns a join stream with `objectMode` set to `true`.
     32 *
     33 * @param {Options} [options] - stream options
     34 * @param {string} [options.sep='\n'] - separator used to join streamed data
     35 * @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to `strings`
     36 * @param {NonNegativeNumber} [options.highWaterMark] - specifies the `Buffer` level for when `write()` starts returning `false`
     37 * @param {boolean} [options.allowHalfOpen=false] - specifies whether the stream should remain open even if one side ends
     38 * @param {boolean} [options.readableObjectMode=false] - specifies whether the readable side should be in object mode
     39 * @throws {TypeError} options argument must be an object
     40 * @throws {TypeError} must provide valid options
     41 * @returns {JoinStream} join stream
     42 *
     43 * @example
     44 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     45 *
     46 * function log( chunk ) {
     47 *     console.log( chunk.toString() );
     48 * }
     49 *
     50 * var stream = objectMode({
     51 *     'sep': ','
     52 * });
     53 *
     54 * stream.pipe( inspectStream( log ) );
     55 *
     56 * stream.write( 'a' );
     57 * stream.write( 'b' );
     58 * stream.write( 'c' );
     59 *
     60 * stream.end();
     61 *
     62 * // prints: 'a,b,c'
     63 */
     64 function objectMode( options ) {
     65 	var opts;
     66 	if ( arguments.length ) {
     67 		if ( !isObject( options ) ) {
     68 			throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
     69 		}
     70 		opts = copy( options );
     71 	} else {
     72 		opts = {};
     73 	}
     74 	opts.objectMode = true;
     75 	return new Stream( opts );
     76 }
     77 
     78 
     79 // EXPORTS //
     80 
     81 module.exports = objectMode;