All files / array/src findAndReplace.ts

100% Statements 6/6
100% Branches 0/0
100% Functions 3/3
100% Lines 5/5

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 281x 1x                                           2x 2x 1x    
import { ValueOrProvider, valueOrProviderResult } from "../../object/dist";
import { findAndThen } from "./findAndThen";
 
/**
 * Replaces 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, 2];
 *
 * findAndReplace(2)(array);
 *
 * console.log(array); // [1, 4, 3, 2]
 * ```
 *
 * @typeParam T - the {@link Array} element type
 * @param array - the {@link Array} to modify
 * @param predicate - the {@link Predicate} to match
 * @param value - the new value
 */
export const findAndReplace = <T>(value: ValueOrProvider<T, [T]>) =>
  findAndThen<T, void, T[]>(
    (v, index, array) => (array[index] = valueOrProviderResult(value, v))
  );