All files / iterable/src isIterable.ts

100% Statements 3/3
100% Branches 0/0
100% Functions 2/2
100% Lines 2/2

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                                          12x 12x    
/**
 * Checks if a value is an {@link Iterable}.
 *
 * @example
 * Is String iterable?
 * ```ts
 * const result = isIterable("");
 * console.log(result); // true
 * ```
 *
 * @example
 * Is Array iterable?
 * ```ts
 * const result = isIterable([]);
 * console.log(result); // true
 * ```
 *
 * @typeParam T - the {@link Iterable} element type
 * @param value - the value to check
 * @returns `true` if `value` is an {@link Iterable}, otherwise `false`
 */
export const isIterable = <T>(value: unknown): value is Iterable<T> => {
  return Symbol.iterator in Object(value);
};