rc-js-util/src/iterators/impl/iterator-empty-iterator.ts

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

/**
 * @public
 * An iterator that is done.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const iteratorEmptyIterator: IterableIterator<any> & { result: { done: true, value: any } } = {
    [Symbol.iterator]()
    {
        return this;
    },
    next(): IteratorResult<number>
    {
        return this.result;
    },
    result: { done: true, value: null },
};