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

A utility library for TypeScript.

import { OrElse } from "./internals/types.js";

//#region src/array/setAtOrElse.d.ts

/**
 * `setAtOrElse(target, idx, value, orElse)`
 *
 * Sets the value at the specified `idx` in `target` to `value`. If the index is out of bounds, calls `orElse` with the original array.
 *
 * ```ts
 * setAtOrElse([1, 2, 3], 1, 9, () => []); // [1, 9, 3]
 * setAtOrElse([1, 2, 3], -1, 9, () => []); // [1, 2, 9]
 * setAtOrElse([1, 2, 3], 5, 9, (arr) => arr); // [1, 2, 3]
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3],
 *     setAtOrElse(1, 9, () => []),
 * ); // [1, 9, 3]
 * pipe(
 *     [1, 2, 3],
 *     setAtOrElse(-1, 9, () => []),
 * ); // [1, 2, 9]
 * pipe(
 *     [1, 2, 3],
 *     setAtOrElse(5, 9, (arr) => arr),
 * ); // [1, 2, 3]
 * ```
 */
declare const setAtOrElse: {
  <T, U>(idx: number, value: NoInfer<T>, orElse: OrElse<T, U>): (target: T[]) => T[] | U;
  <T, U>(idx: number, value: NoInfer<T>, orElse: OrElse<T, U>): (target: readonly T[]) => readonly T[] | U;
  <T, U>(target: T[], idx: number, value: NoInfer<T>, orElse: OrElse<T, U>): T[] | U;
  <T, U>(target: readonly T[], idx: number, value: NoInfer<T>, orElse: OrElse<T, U>): readonly T[] | U;
};
//#endregion
export { setAtOrElse };