@monstermann/map 0.1.2 → 0.3.0

package/dist/Map/reject.mjs

@@ -3,17 +3,28 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/reject.ts
 /**
+* # reject
+*
 * ```ts
-* function Map.reject(map, by)
+* function Map.reject<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     by: (
+*         value: NoInfer<V>,
+*         key: NoInfer<K>,
+*         target: ReadonlyMap<K, V>,
+*     ) => boolean,
+* ): ReadonlyMap<K, V>
 * ```
 *
+* Returns a new map excluding entries that satisfy the predicate function.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.reject(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -22,11 +33,11 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "a" => 1 }
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Map } from "@monstermann/map";
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -34,6 +45,7 @@ import { cloneMap } from "@monstermann/remmi";
 *     Map.reject((value) => value > 1),
 * ); // Map(1) { "a" => 1 }
 * ```
+*
 */
 const reject = dfdlT((target, by) => {
 	let result;

package/dist/Map/remove.d.mts

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

package/dist/Map/remove.mjs

@@ -3,17 +3,24 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/remove.ts
 /**
+* # remove
+*
 * ```ts
-* function Map.remove(map, key)
+* function Map.remove<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+* ): ReadonlyMap<K, V>
 * ```
 *
+* Removes the specified key from the map. Returns the original map if the key doesn't exist.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.remove(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -21,7 +28,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * Map.remove(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -29,11 +36,11 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(2) { "a" => 1, "b" => 2 }
 * ```
 *
-* ```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.remove("c"),
 * ); // Map(2) { "a" => 1, "b" => 2 }
 * ```
+*
 */
 const remove = dfdlT((target, key) => {
 	if (!target.has(key)) return target;

package/dist/Map/removeAll.d.mts

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

package/dist/Map/removeAll.mjs

@@ -3,17 +3,24 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeAll.ts
 /**
+* # removeAll
+*
 * ```ts
-* function Map.removeAll(map, keys)
+* function Map.removeAll<K, V>(
+*     target: ReadonlyMap<K, V>,
+*     keys: Iterable<NoInfer<K>>,
+* ): ReadonlyMap<K, V>
 * ```
 *
+* Removes all specified keys from the map.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.removeAll(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -22,7 +29,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * Map.removeAll(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -31,11 +38,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],
 *         ["c", 3],
@@ -44,7 +51,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *         ["c", 3],
@@ -52,6 +59,7 @@ import { cloneMap } from "@monstermann/remmi";
 *     Map.removeAll(["d", "e"]),
 * ); // Map(3) { "a" => 1, "b" => 2, "c" => 3 }
 * ```
+*
 */
 const removeAll = dfdlT((target, keys) => {
 	let result;

package/dist/Map/removeOr.d.mts

@@ -1,16 +1,24 @@
 //#region src/Map/removeOr.d.ts
 /**
+ * # removeOr
+ *
  * ```ts
- * function Map.removeOr(map, key, or)
+ * function Map.removeOr<K, V, U>(
+ *     target: ReadonlyMap<K, V>,
+ *     key: NoInfer<K>,
+ *     or: U,
+ * ): Map<K, V> | U
  * ```
  *
+ * Removes the specified key from the map, or returns the fallback value if the key doesn't exist.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.removeOr(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -19,7 +27,7 @@
  * ); // Map(1) { "b" => 2 }
  *
  * Map.removeOr(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -28,11 +36,11 @@
  * ); // null
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -40,13 +48,14 @@
  * ); // Map(1) { "b" => 2 }
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
  *     Map.removeOr("c", null),
  * ); // null
  * ```
+ *
  */
 declare const removeOr: {
   <K, V, U>(key: NoInfer<K>, or: U): (target: ReadonlyMap<K, V>) => Map<K, V> | U;

package/dist/Map/removeOr.mjs

@@ -3,17 +3,25 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeOr.ts
 /**
+* # removeOr
+*
 * ```ts
-* function Map.removeOr(map, key, or)
+* function Map.removeOr<K, V, U>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+*     or: U,
+* ): Map<K, V> | U
 * ```
 *
+* Removes the specified key from the map, or returns the fallback value if the key doesn't exist.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.removeOr(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -22,7 +30,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * Map.removeOr(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -31,11 +39,11 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // null
 * ```
 *
-* ```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(1) { "b" => 2 }
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     Map.removeOr("c", null),
 * ); // null
 * ```
+*
 */
 const removeOr = dfdlT((target, key, or) => {
 	if (!target.has(key)) return or;

package/dist/Map/removeOrElse.d.mts

@@ -1,19 +1,24 @@
-import { OrElse } from "./internals/types.mjs";
-
 //#region src/Map/removeOrElse.d.ts
-
 /**
+ * # removeOrElse
+ *
  * ```ts
- * function Map.removeOrElse(map, key, orElse)
+ * function Map.removeOrElse<K, V, U>(
+ *     target: ReadonlyMap<K, V>,
+ *     key: NoInfer<K>,
+ *     orElse: (target: ReadonlyMap<K, V>) => U,
+ * ): Map<K, V> | U
  * ```
  *
+ * Removes the specified key from the map, or calls the fallback function if the key doesn't exist.
+ *
  * ## Example
  *
- * ```ts
+ * ```ts [data-first]
  * import { Map } from "@monstermann/map";
  *
  * Map.removeOrElse(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -22,7 +27,7 @@ import { OrElse } from "./internals/types.mjs";
  * ); // Map(1) { "b" => 2 }
  *
  * Map.removeOrElse(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -31,11 +36,11 @@ import { OrElse } from "./internals/types.mjs";
  * ); // 2
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -43,17 +48,18 @@ import { OrElse } from "./internals/types.mjs";
  * ); // Map(1) { "b" => 2 }
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["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;
+  <K, V, U>(key: NoInfer<K>, orElse: (target: ReadonlyMap<K, V>) => U): (target: ReadonlyMap<K, V>) => Map<K, V> | U;
+  <K, V, U>(target: ReadonlyMap<K, V>, key: NoInfer<K>, orElse: (target: ReadonlyMap<K, V>) => U): Map<K, V> | U;
 };
 //#endregion
 export { removeOrElse };

package/dist/Map/removeOrElse.mjs

@@ -3,17 +3,25 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeOrElse.ts
 /**
+* # removeOrElse
+*
 * ```ts
-* function Map.removeOrElse(map, key, orElse)
+* function Map.removeOrElse<K, V, U>(
+*     target: ReadonlyMap<K, V>,
+*     key: NoInfer<K>,
+*     orElse: (target: ReadonlyMap<K, V>) => U,
+* ): Map<K, V> | U
 * ```
 *
+* Removes the specified key from the map, or calls the fallback function if the key doesn't exist.
+*
 * ## Example
 *
-* ```ts
+* ```ts [data-first]
 * import { Map } from "@monstermann/map";
 *
 * Map.removeOrElse(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -22,7 +30,7 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // Map(1) { "b" => 2 }
 *
 * Map.removeOrElse(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
@@ -31,11 +39,11 @@ import { cloneMap } from "@monstermann/remmi";
 * ); // 2
 * ```
 *
-* ```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(1) { "b" => 2 }
 *
 * pipe(
-*     Map.create([
+*     new Map([
 *         ["a", 1],
 *         ["b", 2],
 *     ]),
 *     Map.removeOrElse("c", (map) => map.size),
 * ); // 2
 * ```
+*
 */
 const removeOrElse = dfdlT((target, key, orElse) => {
 	if (!target.has(key)) return orElse(target);

package/dist/Map/removeOrThrow.d.mts

@@ -1,16 +1,23 @@
 //#region src/Map/removeOrThrow.d.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],
  *     ]),
@@ -18,7 +25,7 @@
  * ); // Map(1) { "b" => 2 }
  *
  * Map.removeOrThrow(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -26,11 +33,11 @@
  * ); // throws FnError
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Map } from "@monstermann/map";
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
@@ -38,13 +45,14 @@
  * ); // Map(1) { "b" => 2 }
  *
  * pipe(
- *     Map.create([
+ *     new Map([
  *         ["a", 1],
  *         ["b", 2],
  *     ]),
  *     Map.removeOrThrow("c"),
  * ); // throws FnError
  * ```
+ *
  */
 declare const removeOrThrow: {
   <K, V>(key: NoInfer<K>): (target: ReadonlyMap<K, V>) => Map<K, V>;