time-to-botec

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

index.js (2405B)

      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 * Create a readable stream from an iterator.
     23 *
     24 * @module @stdlib/streams/node/from-iterator
     25 *
     26 * @example
     27 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     28 * var randu = require( '@stdlib/random/iter/randu' );
     29 * var iteratorStream = require( '@stdlib/streams/node/from-iterator' );
     30 *
     31 * function log( chunk ) {
     32 *    console.log( chunk.toString() );
     33 * }
     34 *
     35 * var opts = {
     36 *     'iter': 10
     37 * };
     38 *
     39 * var stream = iteratorStream( randu( opts ) );
     40 *
     41 * stream.pipe( inspectStream( log ) );
     42 *
     43 * @example
     44 * var randu = require( '@stdlib/random/iter/randu' );
     45 * var iteratorStream = require( '@stdlib/streams/node/from-iterator' );
     46 *
     47 * var opts = {
     48 *     'sep': ',',
     49 *     'objectMode': false,
     50 *     'encoding': 'utf8',
     51 *     'highWaterMark': 64
     52 * };
     53 *
     54 * var createStream = iteratorStream.factory( opts );
     55 *
     56 * // Create 10 identically configured streams...
     57 * var streams = [];
     58 * var i;
     59 * for ( i = 0; i < 10; i++ ) {
     60 *     streams.push( createStream( randu() ) );
     61 * }
     62 *
     63 * @example
     64 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     65 * var randu = require( '@stdlib/random/iter/randu' );
     66 * var iteratorStream = require( '@stdlib/streams/node/from-iterator' );
     67 *
     68 * function log( v ) {
     69 *    console.log( v );
     70 * }
     71 *
     72 * var opts = {
     73 *     'iter': 10
     74 * };
     75 *
     76 * var stream = iteratorStream.objectMode( randu( opts ) );
     77 *
     78 * stream.pipe( inspectStream.objectMode( log ) );
     79 */
     80 
     81 
     82 // MODULES //
     83 
     84 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     85 var stream = require( './main.js' );
     86 var objectMode = require( './object_mode.js' );
     87 var factory = require( './factory.js' );
     88 
     89 
     90 // MAIN //
     91 
     92 setReadOnly( stream, 'objectMode', objectMode );
     93 setReadOnly( stream, 'factory', factory );
     94 
     95 
     96 // EXPORTS //
     97 
     98 module.exports = stream;