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

A utility library for TypeScript.

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

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

/**
 * `removeAtOrElse(target, idx, orElse)`
 *
 * Removes the element at index `idx` from `target` array. Supports negative indices to count from the end. If the index is out of bounds, calls the `orElse` function with the original array and returns its result.
 *
 * ```ts
 * removeAtOrElse([1, 2, 3], 1, () => []); // [1, 3]
 * removeAtOrElse([1, 2, 3], 5, (arr) => arr); // [1, 2, 3]
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3],
 *     removeAtOrElse(1, () => []),
 * ); // [1, 3]
 *
 * pipe(
 *     [1, 2, 3],
 *     removeAtOrElse(5, (arr) => arr),
 * ); // [1, 2, 3]
 * ```
 */
declare const removeAtOrElse: {
  <T, U>(idx: number, orElse: OrElse<T, U>): (target: readonly T[]) => T[] | U;
  <T, U>(target: readonly T[], idx: number, orElse: OrElse<T, U>): T[] | U;
};
//#endregion
export { removeAtOrElse };