All files / array/src isEmpty.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 26                                            2x 2x    
import { EmptyArrayLike } from "./_types";
 
/**
 * Checks if an {@link ArrayLike} contains any element
 *
 * @example
 * Returns `true` if the {@link ArrayLike} is empty
 * ```ts
 * const result = isEmpty([]);
 * console.log(result); // true
 * ```
 *
 * @example
 * Works with Strings, too
 * ```ts
 * const result = isEmpty(" ");
 * console.log(result); // false
 * ```
 *
 * @param array - the {@link ArrayLike} to check
 * @returns `true` if the {@link ArrayLike} is empty, otherwise `false`
 */
export const isEmpty = (array: ArrayLike<unknown>): array is EmptyArrayLike => {
  return !array.length;
};