ix/src/iterable/empty.ts

The Interactive Extensions for JavaScript

import { IterableX } from './iterablex.js';

class EmptyIterable extends IterableX<never> {
  *[Symbol.iterator](): Iterator<never> {
    // eslint-disable-next-line no-empty
  }
}

/**
 * Returns an empty iterable sequence.
 *
 * @template TSource The type used for the iterable type parameter of the resulting sequence.
 * @returns {IterableX<never>} An iterable sequence with no elements.
 */
export function empty(): IterableX<never> {
  return new EmptyIterable();
}