@monstermann/map 0.1.2 → 0.3.0

package/dist/Map/removeOrThrow.mjs

@@ -3,17 +3,24 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeOrThrow.ts
 /**
+* # removeOrThrow
+*
 * ```ts
-* function Map.removeOrThrow(map, key)
+* function Map.removeOrThrow<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+* ): Map<K, V>
 * ```
 *
+* Removes the specified key from the map, or throws an error if the key doesn't exist.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.removeOrThrow(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -21,7 +28,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * Map.removeOrThrow(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -29,11 +36,11 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // throws FnError
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -41,13 +48,14 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["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.");

package/dist/Map/set.d.mts

@@ -1,16 +1,24 @@
 //#region src/Map/set.d.ts
 /**
+ * # set
+ *
  * ```ts
- * function Map.set(map, key, value)
+ * function Map.set<K, V>(
+ *     target: ReadonlyMap<K, V>,
+ *     key: NoInfer<K>,
+ *     value: NoInfer<V>,
+ * ): ReadonlyMap<K, V>
  * ```
  *
+ * Sets or updates the value for the specified key in the map.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.set(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -19,7 +27,7 @@
  * ); // Map(2) { "a" => 10, "b" => 2 }
  *
  * Map.set(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -28,11 +36,11 @@
  * ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -40,13 +48,14 @@
  * ); // Map(2) { "a" => 10, "b" => 2 }
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["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>;

package/dist/Map/set.mjs

@@ -3,17 +3,25 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/set.ts
 /**
+* # set
+*
 * ```ts
-* function Map.set(map, key, value)
+* function Map.set<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+*     value: NoInfer<V>,
+* ): ReadonlyMap<K, V>
 * ```
 *
+* Sets or updates the value for the specified key in the map.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.set(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -22,7 +30,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(2) { "a" => 10, "b" => 2 }
 *
 * Map.set(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -31,11 +39,11 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -43,13 +51,14 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(2) { "a" => 10, "b" => 2 }
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["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;

package/dist/Map/some.d.mts

@@ -0,0 +1,52 @@
+//#region src/Map/some.d.ts
+/**
+ * # some
+ *
+ * ```ts
+ * function Map.some<K, V>(
+ *     target: ReadonlyMap<K, V>,
+ *     predicate: (
+ *         value: NoInfer<V>,
+ *         key: NoInfer<K>,
+ *         target: ReadonlyMap<K, V>,
+ *     ) => boolean,
+ * ): boolean
+ * ```
+ *
+ * Returns `true` if at least one entry in the map satisfies the provided `predicate` function, otherwise returns `false`.
+ *
+ * ## Example
+ *
+ * ```ts [data-first]
+ * import { Map } from "@monstermann/map";
+ *
+ * Map.some(
+ *     new Map([
+ *         ["a", 1],
+ *         ["b", 2],
+ *         ["c", 3],
+ *     ]),
+ *     (value) => value > 2,
+ * ); // true
+ * ```
+ *
+ * ```ts [data-last]
+ * import { Map } from "@monstermann/map";
+ *
+ * pipe(
+ *     new Map([
+ *         ["a", 1],
+ *         ["b", 2],
+ *         ["c", 3],
+ *     ]),
+ *     Map.some((value) => value > 2),
+ * ); // true
+ * ```
+ *
+ */
+declare const some: {
+  <K, V>(predicate: (value: NoInfer<V>, key: NoInfer<K>, target: ReadonlyMap<K, V>) => boolean): (target: ReadonlyMap<K, V>) => boolean;
+  <K, V>(target: ReadonlyMap<K, V>, predicate: (value: NoInfer<V>, key: NoInfer<K>, target: ReadonlyMap<K, V>) => boolean): boolean;
+};
+//#endregion
+export { some };

package/dist/Map/some.mjs

@@ -0,0 +1,55 @@
+import { dfdlT } from "@monstermann/dfdl";
+
+//#region src/Map/some.ts
+/**
+* # some
+*
+* ```ts
+* function Map.some<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     predicate: (
+*         value: NoInfer<V>,
+*         key: NoInfer<K>,
+*         target: ReadonlyMap<K, V>,
+*     ) => boolean,
+* ): boolean
+* ```
+*
+* Returns `true` if at least one entry in the map satisfies the provided `predicate` function, otherwise returns `false`.
+*
+* ## Example
+*
+* ```ts [data-first]
+* import { Map } from "@monstermann/map";
+*
+* Map.some(
+*     new Map([
+*         ["a", 1],
+*         ["b", 2],
+*         ["c", 3],
+*     ]),
+*     (value) => value > 2,
+* ); // true
+* ```
+*
+* ```ts [data-last]
+* import { Map } from "@monstermann/map";
+*
+* pipe(
+*     new Map([
+*         ["a", 1],
+*         ["b", 2],
+*         ["c", 3],
+*     ]),
+*     Map.some((value) => value > 2),
+* ); // true
+* ```
+*
+*/
+const some = dfdlT((target, predicate) => {
+	for (const [key, value] of target) if (predicate(value, key, target)) return true;
+	return false;
+}, 2);
+
+//#endregion
+export { some };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@monstermann/map",
     "type": "module",
-    "version": "0.1.2",
+    "version": "0.3.0",
     "description": "Functional utilities for maps.",
     "author": "Michael Ostermann <michaelostermann@me.com>",
     "license": "MIT",
@@ -34,6 +34,6 @@
     },
     "dependencies": {
         "@monstermann/dfdl": "^0.1.0",
-        "@monstermann/remmi": "^0.0.0"
+        "@monstermann/remmi": "^0.2.0"
     }
 }

package/dist/Map/internals/types.d.mts

@@ -1,14 +0,0 @@
-//#region src/Map/internals/types.d.ts
-type NonNil<T> = Exclude<T, null | undefined>;
-interface MapGuard<K, V, U extends V> {
-  (value: NoInfer<V>, key: NoInfer<K>, target: ReadonlyMap<K, V>): value is U;
-}
-interface MapMap<K, V, U = V> {
-  (value: NoInfer<V>, key: NoInfer<K>, target: ReadonlyMap<K, V>): U;
-}
-type MapPredicate<K, V> = MapMap<K, V, boolean>;
-interface OrElse<K, V, U> {
-  (target: ReadonlyMap<K, V>): U;
-}
-//#endregion
-export { MapGuard, MapMap, MapPredicate, NonNil, OrElse };