@stdlib/iter/replicate/lib/index.js

Standard iterator utilities.

/**
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

/**
* Create an iterator which replicates each iterated value a specified number of times.
*
* @module @stdlib/iter/replicate
*
* @example
* var array2iterator = require( '@stdlib/array/to-iterator' );
* var iterReplicate = require( '@stdlib/iter/replicate' );
*
* var src = array2iterator( [ 1, 2, 3, 4 ] );
* var iter = iterReplicate( src, 2 );
*
* var v = iter.next().value;
* // returns 1
*
* v = iter.next().value;
* // returns 1
*
* v = iter.next().value;
* // returns 2
*
* v = iter.next().value;
* // returns 2
*
* // ...
*/

// MODULES //

var main = require( './main.js' );


// EXPORTS //

module.exports = main;