All files / guard is-non-empty-array.ts

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

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                            2x    
import type { NonEmptyArray } from '../types';
 
/**
 * Checks whether an array has an item, and narrows it so that its first item is defined.
 *
 * @template T - The type of the items.
 * @param items - The array to check.
 * @returns `true` when the array has an item.
 * @example
 * if (isNonEmptyArray(samples)) {
 *   const [first] = samples; // a sample, not `undefined`
 * }
 */
export function isNonEmptyArray<T>(items: readonly T[]): items is NonEmptyArray<T> {
  return items.length > 0;
}