@monstermann/map 0.0.0 → 0.1.0

package/dist/Map/hasNone.d.ts

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

package/dist/Map/hasNone.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/hasNone.ts
 /**
-* `Map.hasNone(map, keys)`
-*
-* Checks if `map` contains none of the specified `keys`. This function supports iterables.
+* ```ts
+* function Map.hasNone(map, keys)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.hasNone(
 *     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/index.d.ts

@@ -1,5 +1,6 @@
 import { clone } from "./clone.js";
 import { compact } from "./compact.js";
+import { create } from "./create.js";
 import { filter } from "./filter.js";
 import { forEach } from "./forEach.js";
 import { get } from "./get.js";
@@ -10,8 +11,8 @@ import { has } from "./has.js";
 import { hasAll } from "./hasAll.js";
 import { hasAny } from "./hasAny.js";
 import { hasNone } from "./hasNone.js";
+import { is } from "./is.js";
 import { isEmpty } from "./isEmpty.js";
-import { isMap } from "./isMap.js";
 import { isShallowEqual } from "./isShallowEqual.js";
 import { map } from "./map.js";
 import { mapEach } from "./mapEach.js";
@@ -29,7 +30,7 @@ import { set } from "./set.js";
 //#region src/Map/index.d.ts
 
 declare namespace Map {
-  export { clone, compact, filter, forEach, get, getOr, getOrElse, getOrThrow, has, hasAll, hasAny, hasNone, isEmpty, isMap, isShallowEqual, map, mapEach, mapOr, mapOrElse, mapOrThrow, reject, remove, removeAll, removeOr, removeOrElse, removeOrThrow, set };
+  export { clone, compact, create, filter, forEach, get, getOr, getOrElse, getOrThrow, has, hasAll, hasAny, hasNone, is, isEmpty, isShallowEqual, map, mapEach, mapOr, mapOrElse, mapOrThrow, reject, remove, removeAll, removeOr, removeOrElse, removeOrThrow, set };
 }
 //#endregion
 export { Map };

package/dist/Map/index.js

@@ -1,6 +1,7 @@
 import { clone } from "./clone.js";
 import { filter } from "./filter.js";
 import { compact } from "./compact.js";
+import { create } from "./create.js";
 import { forEach } from "./forEach.js";
 import { get } from "./get.js";
 import { getOr } from "./getOr.js";
@@ -10,8 +11,8 @@ import { has } from "./has.js";
 import { hasAll } from "./hasAll.js";
 import { hasAny } from "./hasAny.js";
 import { hasNone } from "./hasNone.js";
+import { is } from "./is.js";
 import { isEmpty } from "./isEmpty.js";
-import { isMap } from "./isMap.js";
 import { isShallowEqual } from "./isShallowEqual.js";
 import { map } from "./map.js";
 import { mapEach } from "./mapEach.js";
@@ -30,6 +31,7 @@ import { set } from "./set.js";
 const Map = {
 	clone,
 	compact,
+	create,
 	filter,
 	forEach,
 	get,
@@ -40,8 +42,8 @@ const Map = {
 	hasAll,
 	hasAny,
 	hasNone,
+	is,
 	isEmpty,
-	isMap,
 	isShallowEqual,
 	map,
 	mapEach,

package/dist/Map/is.d.ts

@@ -0,0 +1,30 @@
+//#region src/Map/is.d.ts
+/**
+ * ```ts
+ * function Map.is(target)
+ * ```
+ *
+ * ## Example
+ *
+ * ```ts
+ * import { Map } from "@monstermann/map";
+ *
+ * Map.is(Map.create()); // true
+ * Map.is({}); // false
+ * Map.is([]); // false
+ * ```
+ *
+ * ```ts
+ * import { Map } from "@monstermann/map";
+ *
+ * pipe(Map.create(), Map.is()); // true
+ * pipe({}, Map.is()); // false
+ * pipe([], Map.is()); // false
+ * ```
+ */
+declare const is: {
+  (): (target: unknown) => target is Map<unknown, unknown>;
+  (target: unknown): target is Map<unknown, unknown>;
+};
+//#endregion
+export { is };

package/dist/Map/is.js

@@ -0,0 +1,32 @@
+import { dfdlT } from "@monstermann/dfdl";
+
+//#region src/Map/is.ts
+/**
+* ```ts
+* function Map.is(target)
+* ```
+*
+* ## Example
+*
+* ```ts
+* import { Map } from "@monstermann/map";
+*
+* Map.is(Map.create()); // true
+* Map.is({}); // false
+* Map.is([]); // false
+* ```
+*
+* ```ts
+* import { Map } from "@monstermann/map";
+*
+* pipe(Map.create(), Map.is()); // true
+* pipe({}, Map.is()); // false
+* pipe([], Map.is()); // false
+* ```
+*/
+const is = dfdlT((target) => {
+	return target instanceof Map;
+}, 1);
+
+//#endregion
+export { is };

package/dist/Map/isEmpty.d.ts

@@ -1,17 +1,21 @@
 //#region src/Map/isEmpty.d.ts
 /**
- * `Map.isEmpty(map)`
- *
- * Checks if `map` is empty (has no entries).
+ * ```ts
+ * function Map.isEmpty(map)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.isEmpty(Map.create()); // true
  * Map.isEmpty(Map.create([["a", 1]])); // false
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(Map.create(), Map.isEmpty()); // true
  * pipe(Map.create([["a", 1]]), Map.isEmpty()); // false
  * ```

package/dist/Map/isEmpty.js

@@ -2,18 +2,22 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/isEmpty.ts
 /**
-* `Map.isEmpty(map)`
-*
-* Checks if `map` is empty (has no entries).
+* ```ts
+* function Map.isEmpty(map)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.isEmpty(Map.create()); // true
 * Map.isEmpty(Map.create([["a", 1]])); // false
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(Map.create(), Map.isEmpty()); // true
 * pipe(Map.create([["a", 1]]), Map.isEmpty()); // false
 * ```

package/dist/Map/isShallowEqual.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/isShallowEqual.d.ts
 /**
- * `Map.isShallowEqual(map, source)`
- *
- * Checks if `map` is shallow equal to `source` by comparing their keys and values using strict equality.
+ * ```ts
+ * function Map.isShallowEqual(map, source)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.isShallowEqual(
  *     Map.create([
  *         ["a", 1],
@@ -31,6 +33,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/isShallowEqual.js

@@ -2,13 +2,15 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/isShallowEqual.ts
 /**
-* `Map.isShallowEqual(map, source)`
-*
-* Checks if `map` is shallow equal to `source` by comparing their keys and values using strict equality.
+* ```ts
+* function Map.isShallowEqual(map, source)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.isShallowEqual(
 *     Map.create([
 *         ["a", 1],
@@ -33,6 +35,8 @@ import { dfdlT } from "@monstermann/dfdl";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/map.d.ts

@@ -3,13 +3,15 @@ import { MapMap } from "./internals/types.js";
 //#region src/Map/map.d.ts
 
 /**
- * `Map.map(map, key, transform)`
- *
- * Transforms the value at `key` in `map` using `transform`, returning a new map if the value changes.
+ * ```ts
+ * function Map.map(map, key, transform)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.map(
  *     Map.create([
  *         ["a", 1],
@@ -30,6 +32,8 @@ import { MapMap } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],
@@ -44,6 +48,7 @@ import { MapMap } from "./internals/types.js";
  *         ["b", 2],
  *     ]),
  *     Map.map("c", (value) => value * 2),
+ * ```
  */
 declare const map: {
   <K, V>(key: NoInfer<K>, transform: MapMap<K, V>): (target: Map<K, V>) => Map<K, V>;

package/dist/Map/map.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/map.ts
 /**
-* `Map.map(map, key, transform)`
-*
-* Transforms the value at `key` in `map` using `transform`, returning a new map if the value changes.
+* ```ts
+* function Map.map(map, key, transform)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.map(
 *     Map.create([
 *         ["a", 1],
@@ -30,6 +32,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],
@@ -44,6 +48,7 @@ import { cloneMap } from "@monstermann/remmi";
 *         ["b", 2],
 *     ]),
 *     Map.map("c", (value) => value * 2),
+* ```
 */
 const map = dfdlT((target, key, transform) => {
 	if (!target.has(key)) return target;

package/dist/Map/mapEach.d.ts

@@ -3,13 +3,15 @@ import { MapMap } from "./internals/types.js";
 //#region src/Map/mapEach.d.ts
 
 /**
- * `Map.mapEach(map, fn)`
- *
- * Maps each value in `map` using `fn`, returning a new map with the transformed values.
+ * ```ts
+ * function Map.mapEach(map, fn)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.mapEach(
  *     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/mapEach.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/mapEach.ts
 /**
-* `Map.mapEach(map, fn)`
-*
-* Maps each value in `map` using `fn`, returning a new map with the transformed values.
+* ```ts
+* function Map.mapEach(map, fn)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.mapEach(
 *     Map.create([
 *         ["a", 1],
@@ -20,6 +22,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/mapOr.d.ts

@@ -3,13 +3,15 @@ import { MapMap } from "./internals/types.js";
 //#region src/Map/mapOr.d.ts
 
 /**
- * `Map.mapOr(map, key, transform, or)`
- *
- * Transforms the value at `key` in `map` using `transform`, returning `or` if the key doesn't exist.
+ * ```ts
+ * function Map.mapOr(map, key, transform, or)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.mapOr(
  *     Map.create([
  *         ["a", 1],
@@ -32,6 +34,8 @@ import { MapMap } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/mapOr.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/mapOr.ts
 /**
-* `Map.mapOr(map, key, transform, or)`
-*
-* Transforms the value at `key` in `map` using `transform`, returning `or` if the key doesn't exist.
+* ```ts
+* function Map.mapOr(map, key, transform, or)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.mapOr(
 *     Map.create([
 *         ["a", 1],
@@ -32,6 +34,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/mapOrElse.d.ts

@@ -3,13 +3,15 @@ import { MapMap, OrElse } from "./internals/types.js";
 //#region src/Map/mapOrElse.d.ts
 
 /**
- * `Map.mapOrElse(map, key, transform, orElse)`
- *
- * Transforms the value at `key` in `map` using `transform`, calling `orElse` with the map if the key doesn't exist.
+ * ```ts
+ * function Map.mapOrElse(map, key, transform, orElse)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.mapOrElse(
  *     Map.create([
  *         ["a", 1],
@@ -32,6 +34,8 @@ import { MapMap, OrElse } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/mapOrElse.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/mapOrElse.ts
 /**
-* `Map.mapOrElse(map, key, transform, orElse)`
-*
-* Transforms the value at `key` in `map` using `transform`, calling `orElse` with the map if the key doesn't exist.
+* ```ts
+* function Map.mapOrElse(map, key, transform, orElse)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.mapOrElse(
 *     Map.create([
 *         ["a", 1],
@@ -32,6 +34,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/mapOrThrow.d.ts

@@ -3,13 +3,15 @@ import { MapMap } from "./internals/types.js";
 //#region src/Map/mapOrThrow.d.ts
 
 /**
- * `Map.mapOrThrow(map, key, transform)`
- *
- * Transforms the value at `key` in `map` using `transform`, throwing an error if the key doesn't exist.
+ * ```ts
+ * function Map.mapOrThrow(map, key, transform)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.mapOrThrow(
  *     Map.create([
  *         ["a", 1],
@@ -30,6 +32,8 @@ import { MapMap } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/mapOrThrow.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/mapOrThrow.ts
 /**
-* `Map.mapOrThrow(map, key, transform)`
-*
-* Transforms the value at `key` in `map` using `transform`, throwing an error if the key doesn't exist.
+* ```ts
+* function Map.mapOrThrow(map, key, transform)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.mapOrThrow(
 *     Map.create([
 *         ["a", 1],
@@ -30,6 +32,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/reject.d.ts

@@ -3,13 +3,15 @@ import { MapGuard, MapPredicate } from "./internals/types.js";
 //#region src/Map/reject.d.ts
 
 /**
- * `Map.reject(map, by)`
- *
- * Rejects entries from `map` where `by` returns true for the value.
+ * ```ts
+ * function Map.reject(map, by)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.reject(
  *     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/reject.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/reject.ts
 /**
-* `Map.reject(map, by)`
-*
-* Rejects entries from `map` where `by` returns true for the value.
+* ```ts
+* function Map.reject(map, by)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.reject(
 *     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/remove.d.ts

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