All files / array/src toReverseIterable.ts

100% Statements 3/3
100% Branches 1/1
100% Functions 1/1
100% Lines 3/3

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                                    2x         2x 3x      
/**
 * Returns an {@link Iterable} that yields the elements of an {@link Array} in
 * reverse order.
 *
 * @example
 * ```ts
 * const array = [1, 2, 3];
 *
 * const iterable = toReverseIterable(array);
 *
 * for(const value of iterable) {
 *   console.log(value); // 3, 2, 1
 * }
 * ```
 *
 * @typeParam T - the {@link Array} element type
 */
export function toReverseIterable<T>(array: ArrayLike<T>): IterableIterator<T>;
export function* toReverseIterable<T>(
  array: ArrayLike<T>,
  // internal variables:
  i = array.length
): IterableIterator<T> {
  while (i) {
    yield array[--i] as T;
  }
}