@lou.codes/iterables
Version:
🔁 Iterable and AsyncIterable utils
18 lines (17 loc) • 564 B
JavaScript
import { iterator } from "@lou.codes/constants/Symbol.js";
/**
* Get a `Symbol.iterator` from an iterable.
*
* @category Common
* @example
* ```typescript
* 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 }
* ```
* @param iterable Iterable to get the iterator from.
* @returns Iterator instance.
*/
export const getIterator = iterable => iterable[iterator]();