Function getIterator

  • Get a Symbol.iterator from an iterable or a Symbol.asyncIterator from an asynchronous iterable.

    Example

    const iterator = getIterator([1, 2, 3]);
    iterator.next(); // { value: 1, done: false }
    iterator.next(); // { value: 2, done: false }
    iterator.next(); // { value: 3, done: false }
    iterator.next(); // { value: undefined, done: true }

    Returns

    Iterator instance.

    Type Parameters

    • Iterable extends AsynchronousIterable<unknown>

    Parameters

    • iterable: Iterable

      Iterable to get the iterator from.

    Returns Iterable extends AsynchronousIterable<Item> ? Iterable extends AsyncIterable<Item> ? AsyncIterator<Item, Item, Item> : Iterator<Item, Item, Item> : never