@monstermann/map 0.0.0 → 0.1.1

package/dist/Map/clone.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/clone.d.ts
 /**
- * `Map.clone(target)`
- *
- * Creates a shallow copy of a `Map`, unless marked as mutable with `markAsMutable` inside a mutation context (see [@monstermann/remmi](https://michaelostermann.github.io/remmi/#clonearray-array)).
+ * ```ts
+ * function Map.clone(target)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * const original = Map.create([
  *     ["a", 1],
  *     ["b", 2],
@@ -16,6 +18,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * const original = Map.create([
  *     ["a", 1],
  *     ["b", 2],

package/dist/Map/clone.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/clone.ts
 /**
-* `Map.clone(target)`
-*
-* Creates a shallow copy of a `Map`, unless marked as mutable with `markAsMutable` inside a mutation context (see [@monstermann/remmi](https://michaelostermann.github.io/remmi/#clonearray-array)).
+* ```ts
+* function Map.clone(target)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * const original = Map.create([
 *     ["a", 1],
 *     ["b", 2],
@@ -19,6 +21,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * const original = Map.create([
 *     ["a", 1],
 *     ["b", 2],

package/dist/Map/compact.d.ts

@@ -3,13 +3,15 @@ import { NonNil } from "./internals/types.js";
 //#region src/Map/compact.d.ts
 
 /**
- * `Map.compact(map)`
- *
- * Removes all nullable values from `map`.
+ * ```ts
+ * function Map.compact(map)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.compact(
  *     Map.create([
  *         ["a", 1],
@@ -20,6 +22,8 @@ import { NonNil } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/compact.js

@@ -3,13 +3,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/compact.ts
 /**
-* `Map.compact(map)`
-*
-* Removes all nullable values from `map`.
+* ```ts
+* function Map.compact(map)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.compact(
 *     Map.create([
 *         ["a", 1],
@@ -20,6 +22,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/create.d.ts

@@ -0,0 +1,21 @@
+//#region src/Map/create.d.ts
+/**
+ * ```ts
+ * function Map.create(iterable?)
+ * ```
+ *
+ * ## Example
+ *
+ * ```ts
+ * import { Map } from "@monstermann/map";
+ *
+ * Map.create([
+ *     ["a", 1],
+ *     ["b", 2],
+ *     ["c", 3],
+ * ]) // Map(2) { "a" => 1, "b" => 2, "c" => 3 }
+ * ```
+ */
+declare function create<K, V>(iterable?: Iterable<readonly [K, V]> | null | undefined): Map<K, V>;
+//#endregion
+export { create };

package/dist/Map/create.js

@@ -0,0 +1,24 @@
+//#region src/Map/create.ts
+/**
+* ```ts
+* function Map.create(iterable?)
+* ```
+*
+* ## Example
+*
+* ```ts
+* import { Map } from "@monstermann/map";
+*
+* Map.create([
+*     ["a", 1],
+*     ["b", 2],
+*     ["c", 3],
+* ]) // Map(2) { "a" => 1, "b" => 2, "c" => 3 }
+* ```
+*/
+function create(iterable) {
+	return new globalThis.Map(iterable);
+}
+
+//#endregion
+export { create };

package/dist/Map/filter.d.ts

@@ -3,13 +3,15 @@ import { MapGuard, MapPredicate } from "./internals/types.js";
 //#region src/Map/filter.d.ts
 
 /**
- * `Map.filter(map, predicate)`
- *
- * Filters `map` by keeping only the entries where `predicate` returns true for the value.
+ * ```ts
+ * function Map.filter(map, predicate)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.filter(
  *     Map.create([
  *         ["a", 1],
@@ -21,6 +23,8 @@ import { MapGuard, MapPredicate } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/filter.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/filter.ts
 /**
-* `Map.filter(map, predicate)`
-*
-* Filters `map` by keeping only the entries where `predicate` returns true for the value.
+* ```ts
+* function Map.filter(map, predicate)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.filter(
 *     Map.create([
 *         ["a", 1],
@@ -21,6 +23,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/forEach.d.ts

@@ -3,13 +3,15 @@ import { MapMap } from "./internals/types.js";
 //#region src/Map/forEach.d.ts
 
 /**
- * `Map.forEach(map, fn)`
- *
- * Executes `fn` for each entry in `map` and returns the original map.
+ * ```ts
+ * function Map.forEach(map, fn)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.forEach(
  *     Map.create([
  *         ["a", 1],
@@ -20,6 +22,8 @@ import { MapMap } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/forEach.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/forEach.ts
 /**
-* `Map.forEach(map, fn)`
-*
-* Executes `fn` for each entry in `map` and returns the original map.
+* ```ts
+* function Map.forEach(map, fn)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.forEach(
 *     Map.create([
 *         ["a", 1],
@@ -19,6 +21,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/get.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/get.d.ts
 /**
- * `Map.get(map, key)`
- *
- * Gets the value associated with `key` from `map`, returning `undefined` if the key doesn't exist.
+ * ```ts
+ * function Map.get(map, key)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.get(
  *     Map.create([
  *         ["a", 1],
@@ -25,6 +27,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/get.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/get.ts
 /**
-* `Map.get(map, key)`
-*
-* Gets the value associated with `key` from `map`, returning `undefined` if the key doesn't exist.
+* ```ts
+* function Map.get(map, key)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.get(
 *     Map.create([
 *         ["a", 1],
@@ -27,6 +29,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/getOr.d.ts

@@ -3,13 +3,15 @@ import { NonNil } from "./internals/types.js";
 //#region src/Map/getOr.d.ts
 
 /**
- * `Map.getOr(map, key, or)`
- *
- * Gets the value associated with `key` from `map`, returning `or` if the key doesn't exist or the value is nullable.
+ * ```ts
+ * function Map.getOr(map, key, or)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.getOr(
  *     Map.create([
  *         ["a", 1],
@@ -39,6 +41,8 @@ import { NonNil } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/getOr.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/getOr.ts
 /**
-* `Map.getOr(map, key, or)`
-*
-* Gets the value associated with `key` from `map`, returning `or` if the key doesn't exist or the value is nullable.
+* ```ts
+* function Map.getOr(map, key, or)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.getOr(
 *     Map.create([
 *         ["a", 1],
@@ -38,6 +40,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/getOrElse.d.ts

@@ -3,13 +3,15 @@ import { NonNil, OrElse } from "./internals/types.js";
 //#region src/Map/getOrElse.d.ts
 
 /**
- * `Map.getOrElse(map, key, orElse)`
- *
- * Gets the value associated with `key` from `map`, calling `orElse` with the map if the key doesn't exist or the value is nullable.
+ * ```ts
+ * function Map.getOrElse(map, key, orElse)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.getOrElse(
  *     Map.create([
  *         ["a", 1],
@@ -39,6 +41,8 @@ import { NonNil, OrElse } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/getOrElse.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/getOrElse.ts
 /**
-* `Map.getOrElse(map, key, orElse)`
-*
-* Gets the value associated with `key` from `map`, calling `orElse` with the map if the key doesn't exist or the value is nullable.
+* ```ts
+* function Map.getOrElse(map, key, orElse)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.getOrElse(
 *     Map.create([
 *         ["a", 1],
@@ -38,6 +40,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/getOrThrow.d.ts

@@ -3,13 +3,15 @@ import { NonNil } from "./internals/types.js";
 //#region src/Map/getOrThrow.d.ts
 
 /**
- * `Map.getOrThrow(map, key)`
- *
- * Gets the value associated with `key` from `map`, throwing an error if the key doesn't exist or the value is nullable.
+ * ```ts
+ * function Map.getOrThrow(map, key)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.getOrThrow(
  *     Map.create([
  *         ["a", 1],
@@ -36,6 +38,8 @@ import { NonNil } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/getOrThrow.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/getOrThrow.ts
 /**
-* `Map.getOrThrow(map, key)`
-*
-* Gets the value associated with `key` from `map`, throwing an error if the key doesn't exist or the value is nullable.
+* ```ts
+* function Map.getOrThrow(map, key)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.getOrThrow(
 *     Map.create([
 *         ["a", 1],
@@ -35,6 +37,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/has.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/has.d.ts
 /**
- * `Map.has(map, key)`
- *
- * Checks if `map` contains the specified `key`.
+ * ```ts
+ * function Map.has(map, key)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.has(
  *     Map.create([
  *         ["a", 1],
@@ -25,6 +27,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/has.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/has.ts
 /**
-* `Map.has(map, key)`
-*
-* Checks if `map` contains the specified `key`.
+* ```ts
+* function Map.has(map, key)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.has(
 *     Map.create([
 *         ["a", 1],
@@ -27,6 +29,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/hasAll.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/hasAll.d.ts
 /**
- * `Map.hasAll(map, keys)`
- *
- * Checks if `map` contains all of the specified `keys`. This function supports iterables.
+ * ```ts
+ * function Map.hasAll(map, keys)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.hasAll(
  *     Map.create([
  *         ["a", 1],
@@ -27,6 +29,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/hasAll.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/hasAll.ts
 /**
-* `Map.hasAll(map, keys)`
-*
-* Checks if `map` contains all of the specified `keys`. This function supports iterables.
+* ```ts
+* function Map.hasAll(map, keys)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.hasAll(
 *     Map.create([
 *         ["a", 1],
@@ -29,6 +31,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/hasAny.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/hasAny.d.ts
 /**
- * `Map.hasAny(map, keys)`
- *
- * Checks if `map` contains any of the specified `keys`. This function supports iterables.
+ * ```ts
+ * function Map.hasAny(map, keys)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.hasAny(
  *     Map.create([
  *         ["a", 1],
@@ -25,6 +27,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/hasAny.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/hasAny.ts
 /**
-* `Map.hasAny(map, keys)`
-*
-* Checks if `map` contains any of the specified `keys`. This function supports iterables.
+* ```ts
+* function Map.hasAny(map, keys)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.hasAny(
 *     Map.create([
 *         ["a", 1],
@@ -27,6 +29,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],