@monstermann/map 0.1.1 → 0.2.0

package/dist/Map/{getOrThrow.js → getOrThrow.mjs}

@@ -2,17 +2,24 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/getOrThrow.ts
 /**
+* # getOrThrow
+*
 * ```ts
-* function Map.getOrThrow(map, key)
+* function Map.getOrThrow<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+* ): Exclude<V, null | undefined>
 * ```
 *
+* Gets the value associated with the specified key, or throws an error if the value is `null` or `undefined`.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.getOrThrow(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -20,7 +27,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // 1
 *
 * Map.getOrThrow(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", null],
 *     ]),
@@ -28,7 +35,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // throws FnError
 *
 * Map.getOrThrow(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -36,11 +43,11 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // throws FnError
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -48,7 +55,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // 1
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", null],
 *     ]),
@@ -56,13 +63,14 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // throws FnError
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     Map.getOrThrow("c"),
 * ); // throws FnError
 * ```
+*
 */
 const getOrThrow = dfdlT((target, key) => {
 	const value = target.get(key);

package/dist/Map/{has.d.ts → has.d.mts}

@@ -1,16 +1,23 @@
 //#region src/Map/has.d.ts
 /**
+ * # has
+ *
  * ```ts
- * function Map.has(map, key)
+ * function Map.has<K, V>(
+ *     target: ReadonlyMap<K, V>,
+ *     key: NoInfer<K>,
+ * ): boolean
  * ```
  *
+ * Checks whether the map contains the specified key.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.has(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -18,7 +25,7 @@
  * ); // true
  *
  * Map.has(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -26,11 +33,11 @@
  * ); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -38,13 +45,14 @@
  * ); // true
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
  *     Map.has("c"),
  * ); // false
  * ```
+ *
  */
 declare const has: {
   <K, V>(key: NoInfer<K>): (target: ReadonlyMap<K, V>) => boolean;

package/dist/Map/{has.js → has.mjs}

@@ -2,17 +2,24 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/has.ts
 /**
+* # has
+*
 * ```ts
-* function Map.has(map, key)
+* function Map.has<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+* ): boolean
 * ```
 *
+* Checks whether the map contains the specified key.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.has(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -20,7 +27,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * Map.has(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -28,11 +35,11 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -40,13 +47,14 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     Map.has("c"),
 * ); // false
 * ```
+*
 */
 const has = dfdlT((target, key) => {
 	return target.has(key);

package/dist/Map/{hasAll.d.ts → hasAll.d.mts}

@@ -1,16 +1,23 @@
 //#region src/Map/hasAll.d.ts
 /**
+ * # hasAll
+ *
  * ```ts
- * function Map.hasAll(map, keys)
+ * function Map.hasAll<K, V>(
+ *     target: ReadonlyMap<K, V>,
+ *     keys: Iterable<NoInfer<K>>,
+ * ): boolean
  * ```
  *
+ * Checks whether the map contains all of the specified keys.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.hasAll(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *         ["c", 3],
@@ -19,7 +26,7 @@
  * ); // true
  *
  * Map.hasAll(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *         ["c", 3],
@@ -28,11 +35,11 @@
  * ); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *         ["c", 3],
@@ -41,7 +48,7 @@
  * ); // true
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *         ["c", 3],
@@ -49,6 +56,7 @@
  *     Map.hasAll(["a", "d"]),
  * ); // false
  * ```
+ *
  */
 declare const hasAll: {
   <K, V>(keys: Iterable<NoInfer<K>>): (target: ReadonlyMap<K, V>) => boolean;

package/dist/Map/{hasAll.js → hasAll.mjs}

@@ -2,17 +2,24 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/hasAll.ts
 /**
+* # hasAll
+*
 * ```ts
-* function Map.hasAll(map, keys)
+* function Map.hasAll<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     keys: Iterable<NoInfer<K>>,
+* ): boolean
 * ```
 *
+* Checks whether the map contains all of the specified keys.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.hasAll(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -21,7 +28,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * Map.hasAll(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -30,11 +37,11 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -43,7 +50,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -51,6 +58,7 @@ import { dfdlT } from "@monstermann/dfdl";
 *     Map.hasAll(["a", "d"]),
 * ); // false
 * ```
+*
 */
 const hasAll = dfdlT((target, keys) => {
 	for (const key of keys) if (!target.has(key)) return false;

package/dist/Map/{hasAny.d.ts → hasAny.d.mts}

@@ -1,16 +1,23 @@
 //#region src/Map/hasAny.d.ts
 /**
+ * # hasAny
+ *
  * ```ts
- * function Map.hasAny(map, keys)
+ * function Map.hasAny<K, V>(
+ *     target: ReadonlyMap<K, V>,
+ *     keys: Iterable<NoInfer<K>>,
+ * ): boolean
  * ```
  *
+ * Checks whether the map contains any of the specified keys.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.hasAny(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -18,7 +25,7 @@
  * ); // true
  *
  * Map.hasAny(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -26,11 +33,11 @@
  * ); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -38,13 +45,14 @@
  * ); // true
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
  *     Map.hasAny(["c", "d"]),
  * ); // false
  * ```
+ *
  */
 declare const hasAny: {
   <K, V>(keys: Iterable<NoInfer<K>>): (target: ReadonlyMap<K, V>) => boolean;

package/dist/Map/{hasAny.js → hasAny.mjs}

@@ -2,17 +2,24 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/hasAny.ts
 /**
+* # hasAny
+*
 * ```ts
-* function Map.hasAny(map, keys)
+* function Map.hasAny<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     keys: Iterable<NoInfer<K>>,
+* ): boolean
 * ```
 *
+* Checks whether the map contains any of the specified keys.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.hasAny(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -20,7 +27,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * Map.hasAny(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -28,11 +35,11 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -40,13 +47,14 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     Map.hasAny(["c", "d"]),
 * ); // false
 * ```
+*
 */
 const hasAny = dfdlT((target, keys) => {
 	for (const key of keys) if (target.has(key)) return true;

package/dist/Map/{hasNone.d.ts → hasNone.d.mts}

@@ -1,16 +1,23 @@
 //#region src/Map/hasNone.d.ts
 /**
+ * # hasNone
+ *
  * ```ts
- * function Map.hasNone(map, keys)
+ * function Map.hasNone<K, V>(
+ *     target: ReadonlyMap<K, V>,
+ *     keys: Iterable<NoInfer<K>>,
+ * ): boolean
  * ```
  *
+ * Checks whether the map contains none of the specified keys.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.hasNone(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -18,7 +25,7 @@
  * ); // true
  *
  * Map.hasNone(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -26,11 +33,11 @@
  * ); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -38,13 +45,14 @@
  * ); // true
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
  *     Map.hasNone(["a", "c"]),
  * ); // false
  * ```
+ *
  */
 declare const hasNone: {
   <K, V>(keys: Iterable<NoInfer<K>>): (target: ReadonlyMap<K, V>) => boolean;

package/dist/Map/{hasNone.js → hasNone.mjs}

@@ -2,17 +2,24 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Map/hasNone.ts
 /**
+* # hasNone
+*
 * ```ts
-* function Map.hasNone(map, keys)
+* function Map.hasNone<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     keys: Iterable<NoInfer<K>>,
+* ): boolean
 * ```
 *
+* Checks whether the map contains none of the specified keys.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.hasNone(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -20,7 +27,7 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * Map.hasNone(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -28,11 +35,11 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -40,13 +47,14 @@ import { dfdlT } from "@monstermann/dfdl";
 * ); // true
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     Map.hasNone(["a", "c"]),
 * ); // false
 * ```
+*
 */
 const hasNone = dfdlT((target, keys) => {
 	for (const key of keys) if (target.has(key)) return false;

package/dist/Map/index.d.mts

@@ -0,0 +1,56 @@
+import { clone } from "./clone.mjs";
+import { compact } from "./compact.mjs";
+import { create } from "./create.mjs";
+import { every } from "./every.mjs";
+import { filter } from "./filter.mjs";
+import { find } from "./find.mjs";
+import { findMap } from "./findMap.mjs";
+import { findMapAll } from "./findMapAll.mjs";
+import { findMapOr } from "./findMapOr.mjs";
+import { findMapOrElse } from "./findMapOrElse.mjs";
+import { findMapOrThrow } from "./findMapOrThrow.mjs";
+import { findOr } from "./findOr.mjs";
+import { findOrElse } from "./findOrElse.mjs";
+import { findOrThrow } from "./findOrThrow.mjs";
+import { findRemove } from "./findRemove.mjs";
+import { findRemoveOr } from "./findRemoveOr.mjs";
+import { findRemoveOrElse } from "./findRemoveOrElse.mjs";
+import { findRemoveOrThrow } from "./findRemoveOrThrow.mjs";
+import { findReplace } from "./findReplace.mjs";
+import { findReplaceOr } from "./findReplaceOr.mjs";
+import { findReplaceOrElse } from "./findReplaceOrElse.mjs";
+import { findReplaceOrThrow } from "./findReplaceOrThrow.mjs";
+import { forEach } from "./forEach.mjs";
+import { get } from "./get.mjs";
+import { getOr } from "./getOr.mjs";
+import { getOrElse } from "./getOrElse.mjs";
+import { getOrThrow } from "./getOrThrow.mjs";
+import { has } from "./has.mjs";
+import { hasAll } from "./hasAll.mjs";
+import { hasAny } from "./hasAny.mjs";
+import { hasNone } from "./hasNone.mjs";
+import { is } from "./is.mjs";
+import { isEmpty } from "./isEmpty.mjs";
+import { isShallowEqual } from "./isShallowEqual.mjs";
+import { map } from "./map.mjs";
+import { mapEach } from "./mapEach.mjs";
+import { mapOr } from "./mapOr.mjs";
+import { mapOrElse } from "./mapOrElse.mjs";
+import { mapOrThrow } from "./mapOrThrow.mjs";
+import { none } from "./none.mjs";
+import { reject } from "./reject.mjs";
+import { remove } from "./remove.mjs";
+import { removeAll } from "./removeAll.mjs";
+import { removeOr } from "./removeOr.mjs";
+import { removeOrElse } from "./removeOrElse.mjs";
+import { removeOrThrow } from "./removeOrThrow.mjs";
+import { set } from "./set.mjs";
+import { some } from "./some.mjs";
+
+//#region src/Map/index.d.ts
+
+declare namespace Map {
+  export { clone, compact, create, every, filter, find, findMap, findMapAll, findMapOr, findMapOrElse, findMapOrThrow, findOr, findOrElse, findOrThrow, findRemove, findRemoveOr, findRemoveOrElse, findRemoveOrThrow, findReplace, findReplaceOr, findReplaceOrElse, findReplaceOrThrow, forEach, get, getOr, getOrElse, getOrThrow, has, hasAll, hasAny, hasNone, is, isEmpty, isShallowEqual, map, mapEach, mapOr, mapOrElse, mapOrThrow, none, reject, remove, removeAll, removeOr, removeOrElse, removeOrThrow, set, some };
+}
+//#endregion
+export { Map };