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

Export assignment iterUnion

• iterUnion(iter0: Iterator, iter1: Iterator, ...iterN: Array<Iterator>): Iterator

• Returns an iterator which returns the union of two or more iterators.

  Notes

  • Value "uniqueness" is determined according to strict equality.
  • A returned iterator internally buffers unique values and, thus, has O(N) memory requirements, where N is the total number of source iterator values.
  • If an environment supports Symbol.iterator and all provided iterators are iterable, the returned iterator is iterable.

  Parameters

  • iter0: Iterator

    first iterator

  • iter1: Iterator

    second iterator

  • Rest ...iterN: Array<Iterator>

    subsequent iterators

  Returns Iterator

  iterator

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  var it1 = array2iterator( [ 1, 2, 1, 2, 4 ] );
  var it2 = array2iterator( [ 1, 2, 5, 2, 3 ] );
  
  var iter = iterUnion( it1, it2 );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 4
  
  v = iter.next().value;
  // returns 5
  
  v = iter.next().value;
  // returns 3
  
  var bool = iter.next().done;
  // returns true