@monstermann/fn/dist/map/removeOr.d.ts

A utility library for TypeScript.

//#region src/map/removeOr.d.ts
/**
 * `removeOr(map, key, or)`
 *
 * Removes the entry with the specified `key` from `map`, returning `or` if the key doesn't exist.
 *
 * ```ts
 * removeOr(
 *     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     "a",
 *     null,
 * ); // Map(1) { "b" => 2 }
 *
 * removeOr(
 *     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     "c",
 *     null,
 * ); // null
 * ```
 *
 * ```ts
 * pipe(
 *     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     removeOr("a", null),
 * ); // Map(1) { "b" => 2 }
 *
 * pipe(
 *     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     removeOr("c", null),
 * ); // null
 * ```
 */
declare const removeOr: {
  <K, V, U>(key: NoInfer<K>, or: U): (target: ReadonlyMap<K, V>) => Map<K, V> | U;
  <K, V, U>(target: ReadonlyMap<K, V>, key: NoInfer<K>, or: U): Map<K, V> | U;
};
//#endregion
export { removeOr };