ix/src/iterable/repeatvalue.ts

The Interactive Extensions for JavaScript

import { of } from './of.js';
import { RepeatIterable } from './operators/repeat.js';
import { IterableX } from './iterablex.js';

/**
 * Repeats a given value for the specified number of times as an iterable.
 *
 * @template TSource The type of element to repeat.
 * @param {TSource} value The value to repeat as an iterable.
 * @param {number} [count=-1] The number of times to repeat the value, infinite if not specified.
 * @returns {AsyncIterableX<TSource>} An iterable with a single item that is repeated over the specified times.
 */
export function repeatValue<TSource>(value: TSource, count = -1): IterableX<TSource> {
  return new RepeatIterable<TSource>(of(value), count);
}