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

Export assignment iterLength

• iterLength(iterator: Iterator): number

• Consumes an entire iterator and returns the number of iterated values (i.e., the iterator length).

  Parameters

  • iterator: Iterator

    input iterator

  Returns number

  iterator length

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  var it = array2iterator( [ 0, 0, 0, 0, 1 ] );
  
  var v = iterLength( it );
  // returns 5