@monstermann/map 0.0.0

package/dist/Map/removeOrElse.d.ts

@@ -0,0 +1,55 @@
+import { OrElse } from "./internals/types.js";
+
+//#region src/Map/removeOrElse.d.ts
+
+/**
+ * `Map.removeOrElse(map, key, orElse)`
+ *
+ * Removes the entry with the specified `key` from `map`, calling `orElse` with the map if the key doesn't exist.
+ *
+ * ## Example
+ *
+ * ```ts
+ * Map.removeOrElse(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     "a",
+ *     () => null,
+ * ); // Map(1) { "b" => 2 }
+ *
+ * Map.removeOrElse(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     "c",
+ *     (map) => map.size,
+ * ); // 2
+ * ```
+ *
+ * ```ts
+ * pipe(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     Map.removeOrElse("a", () => null),
+ * ); // Map(1) { "b" => 2 }
+ *
+ * pipe(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     Map.removeOrElse("c", (map) => map.size),
+ * ); // 2
+ * ```
+ */
+declare const removeOrElse: {
+  <K, V, U>(key: NoInfer<K>, orElse: OrElse<K, V, U>): (target: ReadonlyMap<K, V>) => Map<K, V> | U;
+  <K, V, U>(target: ReadonlyMap<K, V>, key: NoInfer<K>, orElse: OrElse<K, V, U>): Map<K, V> | U;
+};
+//#endregion
+export { removeOrElse };

package/dist/Map/removeOrElse.js

@@ -0,0 +1,58 @@
+import { dfdlT } from "@monstermann/dfdl";
+import { cloneMap } from "@monstermann/remmi";
+
+//#region src/Map/removeOrElse.ts
+/**
+* `Map.removeOrElse(map, key, orElse)`
+*
+* Removes the entry with the specified `key` from `map`, calling `orElse` with the map if the key doesn't exist.
+*
+* ## Example
+*
+* ```ts
+* Map.removeOrElse(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     "a",
+*     () => null,
+* ); // Map(1) { "b" => 2 }
+*
+* Map.removeOrElse(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     "c",
+*     (map) => map.size,
+* ); // 2
+* ```
+*
+* ```ts
+* pipe(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     Map.removeOrElse("a", () => null),
+* ); // Map(1) { "b" => 2 }
+*
+* pipe(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     Map.removeOrElse("c", (map) => map.size),
+* ); // 2
+* ```
+*/
+const removeOrElse = dfdlT((target, key, orElse) => {
+	if (!target.has(key)) return orElse(target);
+	const result = cloneMap(target);
+	result.delete(key);
+	return result;
+}, 3);
+
+//#endregion
+export { removeOrElse };

package/dist/Map/removeOrThrow.d.ts

@@ -0,0 +1,50 @@
+//#region src/Map/removeOrThrow.d.ts
+/**
+ * `Map.removeOrThrow(map, key)`
+ *
+ * Removes the entry with the specified `key` from `map`, throwing an error if the key doesn't exist.
+ *
+ * ## Example
+ *
+ * ```ts
+ * Map.removeOrThrow(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     "a",
+ * ); // Map(1) { "b" => 2 }
+ *
+ * Map.removeOrThrow(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     "c",
+ * ); // throws FnError
+ * ```
+ *
+ * ```ts
+ * pipe(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     Map.removeOrThrow("a"),
+ * ); // Map(1) { "b" => 2 }
+ *
+ * pipe(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     Map.removeOrThrow("c"),
+ * ); // throws FnError
+ * ```
+ */
+declare const removeOrThrow: {
+  <K, V>(key: NoInfer<K>): (target: ReadonlyMap<K, V>) => Map<K, V>;
+  <K, V>(target: ReadonlyMap<K, V>, key: NoInfer<K>): Map<K, V>;
+};
+//#endregion
+export { removeOrThrow };

package/dist/Map/removeOrThrow.js

@@ -0,0 +1,56 @@
+import { dfdlT } from "@monstermann/dfdl";
+import { cloneMap } from "@monstermann/remmi";
+
+//#region src/Map/removeOrThrow.ts
+/**
+* `Map.removeOrThrow(map, key)`
+*
+* Removes the entry with the specified `key` from `map`, throwing an error if the key doesn't exist.
+*
+* ## Example
+*
+* ```ts
+* Map.removeOrThrow(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     "a",
+* ); // Map(1) { "b" => 2 }
+*
+* Map.removeOrThrow(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     "c",
+* ); // throws FnError
+* ```
+*
+* ```ts
+* pipe(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     Map.removeOrThrow("a"),
+* ); // Map(1) { "b" => 2 }
+*
+* pipe(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     Map.removeOrThrow("c"),
+* ); // throws FnError
+* ```
+*/
+const removeOrThrow = dfdlT((target, key) => {
+	if (!target.has(key)) throw new Error("Map.removeOrThrow: Key does not exist.");
+	const result = cloneMap(target);
+	result.delete(key);
+	return result;
+}, 2);
+
+//#endregion
+export { removeOrThrow };

package/dist/Map/set.d.ts

@@ -0,0 +1,54 @@
+//#region src/Map/set.d.ts
+/**
+ * `Map.set(map, key, value)`
+ *
+ * Sets the `value` for the specified `key` in `map`, returning a new map if the value changes.
+ *
+ * ## Example
+ *
+ * ```ts
+ * Map.set(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     "a",
+ *     10,
+ * ); // Map(2) { "a" => 10, "b" => 2 }
+ *
+ * Map.set(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     "c",
+ *     3,
+ * ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
+ * ```
+ *
+ * ```ts
+ * pipe(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     Map.set("a", 10),
+ * ); // Map(2) { "a" => 10, "b" => 2 }
+ *
+ * pipe(
+ *     Map.create([
+ *         ["a", 1],
+ *         ["b", 2],
+ *     ]),
+ *     Map.set("c", 3),
+ * ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
+ * ```
+ */
+declare const set: {
+  <K, V>(key: NoInfer<K>, value: NoInfer<V>): (target: Map<K, V>) => Map<K, V>;
+  <K, V>(key: NoInfer<K>, value: NoInfer<V>): (target: ReadonlyMap<K, V>) => ReadonlyMap<K, V>;
+  <K, V>(target: Map<K, V>, key: NoInfer<K>, value: NoInfer<V>): Map<K, V>;
+  <K, V>(target: ReadonlyMap<K, V>, key: NoInfer<K>, value: NoInfer<V>): ReadonlyMap<K, V>;
+};
+//#endregion
+export { set };

package/dist/Map/set.js

@@ -0,0 +1,58 @@
+import { dfdlT } from "@monstermann/dfdl";
+import { cloneMap } from "@monstermann/remmi";
+
+//#region src/Map/set.ts
+/**
+* `Map.set(map, key, value)`
+*
+* Sets the `value` for the specified `key` in `map`, returning a new map if the value changes.
+*
+* ## Example
+*
+* ```ts
+* Map.set(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     "a",
+*     10,
+* ); // Map(2) { "a" => 10, "b" => 2 }
+*
+* Map.set(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     "c",
+*     3,
+* ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
+* ```
+*
+* ```ts
+* pipe(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     Map.set("a", 10),
+* ); // Map(2) { "a" => 10, "b" => 2 }
+*
+* pipe(
+*     Map.create([
+*         ["a", 1],
+*         ["b", 2],
+*     ]),
+*     Map.set("c", 3),
+* ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
+* ```
+*/
+const set = dfdlT((target, key, value) => {
+	if (target.get(key) === value) return target;
+	target = cloneMap(target);
+	target.set(key, value);
+	return target;
+}, 3);
+
+//#endregion
+export { set };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { Map } from "./Map/index.js";
+export { Map };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { Map } from "./Map/index.js";
+
+export { Map };

package/package.json

@@ -0,0 +1,39 @@
+{
+    "name": "@monstermann/map",
+    "type": "module",
+    "version": "0.0.0",
+    "description": "Functional utilities for maps.",
+    "author": "Michael Ostermann <michaelostermann@me.com>",
+    "license": "MIT",
+    "homepage": "https://MichaelOstermann.github.io/map",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/MichaelOstermann/map.git"
+    },
+    "bugs": {
+        "url": "https://github.com/MichaelOstermann/map/issues"
+    },
+    "keywords": [],
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        },
+        "./*": "./dist/*"
+    },
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "bundle": "tsdown",
+        "release": "bun publish --access public"
+    },
+    "dependencies": {
+        "@monstermann/dfdl": "^0.1.0",
+        "@monstermann/remmi": "^0.0.0"
+    }
+}