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

Export assignment iterStrided

• iterStrided(iterator: Iterator, stride: number, offset?: undefined | number, eager?: undefined | false | true): Iterator

• Returns an iterator which steps by a specified amount.

  Notes

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

  Parameters

  • iterator: Iterator

    input iterator

  • stride: number

    stride

  • Optional offset: undefined | number

    offset

  • Optional eager: undefined | false | true

    boolean indicating whether to eagerly advance an input iterator when provided a non-zero offset

  Returns Iterator

  iterator

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  var arr = array2iterator( [ 0, 1, 2, 3, 4, 5, 6, 7 ] );
  
  var iter = iterStrided( arr, 2, 1 );
  
  var r = iter.next().value;
  // returns 1
  
  r = iter.next().value;
  // returns 3
  
  r = iter.next().value;
  // returns 5
  
  // ...