All files / number/src numberSequence.ts

100% Statements 4/4
0% Branches 0/1
100% Functions 1/1
100% Lines 4/4

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33                                              3x       3x 12x 9x      
/**
 * Iterates over a monotone sequence of numbers, starting with
 * `initialNumber`.
 *
 * @example
 * Iterate over `uppercaseAsciiLetterRange`
 * ```ts
 * for (const c of numberSequenceGenerator(1, 2)) {
 *   console.log(c); // 1,3,5,...
 * }
 * ```
 *
 * @example
 * Get the first 3 values of the sequence
 * ```ts
 * const [v1, v2, v3] = numberSequenceGenerator(1, 2);
 * console.log(v1); // 1
 * console.log(v3); // 3
 * console.log(v5); // 5
 * ```
 *
 * @returns a Generator that steps through the numbers
 */
export function* numberSequence(
  initialNumber: number,
  stepSize = 1
): Generator<number, void, unknown> {
  while (true) {
    yield initialNumber;
    initialNumber += stepSize;
  }
}