Function toIterable

  • Takes a value, iterable or asynchronous iterable and yields it.

    Example

    const iterable = toIterable(1);
    const iterator = getIterator(iterable);
    iterator.next(); // { value: 1, done: false }
    iterator.next(); // { value: undefined, done: true }

    See

    Type Parameters

    • const ValueOrIterable

      Generic of value or iterable to yield.

    Parameters

    • valueOrIterable: ValueOrIterable

      Vale or iterable to yield.

    Returns ValueOrIterable extends IsomorphicIterable<Item>
        ? Item extends {
                [asyncIterator]() => AsyncIterator<Item, any, undefined>;
            }
            ? {
                [asyncIterator]() => AsyncIterableIterator<Item>;
                next(...args) => Promise<IteratorResult<Item, any>>;
                return?(value?) => Promise<IteratorResult<Item, any>>;
                throw?(e?) => Promise<IteratorResult<Item, any>>;
            }
            : {
                [iterator]() => IterableIterator<Item>;
                next(...args) => IteratorResult<Item, any>;
                return?(value?) => IteratorResult<Item, any>;
                throw?(e?) => IteratorResult<Item, any>;
            }
        : {
            [iterator]() => IterableIterator<ValueOrIterable>;
            next(...args) => IteratorResult<ValueOrIterable, any>;
            return?(value?) => IteratorResult<ValueOrIterable, any>;
            throw?(e?) => IteratorResult<ValueOrIterable, any>;
        }

    Yielded item or iterable.