npm install @stdlib/iter-fill

Alternatively,

• To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
• If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
• For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

variterFill=require('@stdlib/iter-fill');

Returns aniterator which replaces all values from a providediterator from abegin index to anend index with a staticvalue.

vararray2iterator=require('@stdlib/array-to-iterator');varit=iterFill(array2iterator([1,2,3,4]),3.14);// returns <Object>varv=it.next().value;// returns 3.14v=it.next().value;// returns 3.14v=it.next().value;// returns 3.14// ...

The returnediterator protocol-compliant object has the following properties:

• next: function which returns aniterator protocol-compliant object containing the next iterated value (if one exists) assigned to avalue property and adone property having aboolean value indicating whether theiterator is finished.
• return: function which closes aniterator and returns a single (optional) argument in aniterator protocol-compliant object.

By default, the returnediterator replaces/fills a providediterator's first iterated value through aniterator's last iterated value. To specify an alternative start iteration index at which to begin filling (zero-based andinclusive), provide abegin argument.

vararray2iterator=require('@stdlib/array-to-iterator');varit=iterFill(array2iterator([1,2,3,4]),3.14,2);// returns <Object>varv=it.next().value;// returns 1v=it.next().value;// returns 2v=it.next().value;// returns 3.14v=it.next().value;// returns 3.14varbool=it.next().done;// returns true

By default, the returnediterator continues filling until it replaces all of a providediterator's iterated values. To specify an end iteration index at which to stop filling (zero-based andnon-inclusive), provide anend argument.

vararray2iterator=require('@stdlib/array-to-iterator');varit=iterFill(array2iterator([1,2,3,4]),3.14,1,3);// returns <Object>varv=it.next().value;// returns 1v=it.next().value;// returns 3.14v=it.next().value;// returns 3.14v=it.next().value;// returns 4varbool=it.next().done;// returns true

Ifbegin is greater than or equal toend, the returnediterator does not replace any iterated values.

vararray2iterator=require('@stdlib/array-to-iterator');varit=iterFill(array2iterator([1,2,3,4]),3.14,3,1);// returns <Object>varv=it.next().value;// returns 1v=it.next().value;// returns 2v=it.next().value;// returns 3v=it.next().value;// returns 4varbool=it.next().done;// returns true

• Ifend exceeds the length of the providediterator, the returnediterator replaces the subsequence of iterated values starting frombegin until the last iterated value of the providediterator.
• If an environment supportsSymbol.iteratorand a providediterator is iterable, the returnediterator is iterable.

This package is part ofstdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to developstdlib, see the main projectrepository.

SeeLICENSE.

Copyright © 2016-2025. The StdlibAuthors.