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

A utility library for TypeScript.

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

//#region src/map/compact.d.ts

/**
 * `compact(map)`
 *
 * Removes all nullable values from `map`.
 *
 * ```ts
 * compact(
 *     new Map([
 *         ["a", 1],
 *         ["b", null],
 *         ["c", undefined],
 *     ]),
 * ); // Map(1) { "a" => 1 }
 * ```
 *
 * ```ts
 * pipe(
 *     new Map([
 *         ["a", 1],
 *         ["b", null],
 *         ["c", undefined],
 *     ]),
 *     compact(),
 * ); // Map(1) { "a" => 1 }
 * ```
 */
declare const compact: {
  (): <K, V>(target: Map<K, V>) => Map<K, NonNil<V>>;
  (): <K, V>(target: ReadonlyMap<K, V>) => ReadonlyMap<K, NonNil<V>>;
  <K, V>(target: Map<K, V>): Map<K, NonNil<V>>;
  <K, V>(target: ReadonlyMap<K, V>): ReadonlyMap<K, NonNil<V>>;
};
//#endregion
export { compact };