@monstermann/fn/dist/array/replaceOrThrow.d.ts

A utility library for TypeScript.

//#region src/array/replaceOrThrow.d.ts
/**
 * `replaceOrThrow(target, value, replacement)`
 *
 * Replaces the first occurrence of `value` in `target` with `replacement`. If `value` is not found, throws an error.
 *
 * ```ts
 * replaceOrThrow([1, 2, 3, 2], 2, 9); // [1, 9, 3, 2]
 * replaceOrThrow([1, 2, 3], 4, 9); // throws FnError
 * ```
 *
 * ```ts
 * pipe([1, 2, 3, 2], replaceOrThrow(2, 9)); // [1, 9, 3, 2]
 * pipe([1, 2, 3], replaceOrThrow(4, 9)); // throws FnError
 * ```
 */
declare const replaceOrThrow: {
  <T>(value: NoInfer<T>, replacement: NoInfer<T>): (target: T[]) => T[];
  <T>(value: NoInfer<T>, replacement: NoInfer<T>): (target: readonly T[]) => readonly T[];
  <T>(target: T[], value: NoInfer<T>, replacement: NoInfer<T>): T[];
  <T>(target: readonly T[], value: NoInfer<T>, replacement: NoInfer<T>): readonly T[];
};
//#endregion
export { replaceOrThrow };