External module "iter/map/docs/types/index.d"

Export assignment iterMap

• iterMap(iterator: Iterator, fcn: Callback, thisArg?: any): Iterator

• Returns an iterator which invokes a function for each iterated value.

  Notes

  • When invoked, the callback function is provided two arguments:

    • value: iterated value
    • index: iteration index (zero-based)

  • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

  Parameters

  • iterator: Iterator

    input iterator

  • fcn: Callback

    callback function which transforms an iterated value

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  var randu = require( `@stdlib/random/iter/randu` );
  
  function transform( v ) {
      return v * 10.0;
  }
  
  var iter = iterMap( randu(), transform );
  
  var r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  // ...