All files / array/src findAndDelete.ts

100% Statements 5/5
100% Branches 0/0
100% Functions 2/2
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  1x 1x                                                 2x 1x      
import { Predicate } from "@benneq/predicate";
import { deleteAt } from "./deleteAt";
import { findAndThen } from "./findAndThen";
 
/**
 * Removes the first element from an Array that matches a {@link Predicate}.
 *
 * @mutation
 *
 * @example
 * Square the first element equal to `2`
 * ```ts
 * const array = [1, 2, 3, 4];
 *
 * findAndDelete(isEven)(array);
 *
 * console.log(array); // [1, 3]
 * ```
 *
 * @typeParam T - the {@link Array} element type
 * @param predicate - the {@link Predicate} to match
 */
type FindAndDelete = <T>(
  predicate: Predicate<[T, number, ArrayLike<T>]>,
  fromIndex?: number
) => (array: T[]) => boolean;
 
export const findAndDelete: FindAndDelete = findAndThen(
  (_value, index, array) => deleteAt(index)(array),
  false
);