@monstermann/map 0.0.0 → 0.1.0

package/dist/Map/remove.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/remove.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],
@@ -28,6 +30,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/removeAll.d.ts

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

package/dist/Map/removeAll.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeAll.ts
 /**
-* `Map.removeAll(map, keys)`
-*
-* Removes all entries with the specified `keys` from `map`, returning a new map. This function supports iterables.
+* ```ts
+* function Map.removeAll(map, keys)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.removeAll(
 *     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/removeOr.d.ts

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

package/dist/Map/removeOr.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeOr.ts
 /**
-* `Map.removeOr(map, key, or)`
-*
-* Removes the entry with the specified `key` from `map`, returning `or` if the key doesn't exist.
+* ```ts
+* function Map.removeOr(map, key, or)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.removeOr(
 *     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/removeOrElse.d.ts

@@ -3,13 +3,15 @@ import { OrElse } from "./internals/types.js";
 //#region src/Map/removeOrElse.d.ts
 
 /**
- * `Map.removeOrElse(map, key, orElse)`
- *
- * Removes the entry with the specified `key` from `map`, calling `orElse` with the map if the key doesn't exist.
+ * ```ts
+ * function Map.removeOrElse(map, key, orElse)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.removeOrElse(
  *     Map.create([
  *         ["a", 1],
@@ -30,6 +32,8 @@ import { OrElse } from "./internals/types.js";
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/removeOrElse.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeOrElse.ts
 /**
-* `Map.removeOrElse(map, key, orElse)`
-*
-* Removes the entry with the specified `key` from `map`, calling `orElse` with the map if the key doesn't exist.
+* ```ts
+* function Map.removeOrElse(map, key, orElse)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.removeOrElse(
 *     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/removeOrThrow.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/removeOrThrow.d.ts
 /**
- * `Map.removeOrThrow(map, key)`
- *
- * Removes the entry with the specified `key` from `map`, throwing an error if the key doesn't exist.
+ * ```ts
+ * function Map.removeOrThrow(map, key)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.removeOrThrow(
  *     Map.create([
  *         ["a", 1],
@@ -25,6 +27,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/removeOrThrow.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/removeOrThrow.ts
 /**
-* `Map.removeOrThrow(map, key)`
-*
-* Removes the entry with the specified `key` from `map`, throwing an error if the key doesn't exist.
+* ```ts
+* function Map.removeOrThrow(map, key)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.removeOrThrow(
 *     Map.create([
 *         ["a", 1],
@@ -28,6 +30,8 @@ import { cloneMap } from "@monstermann/remmi";
 * ```
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * pipe(
 *     Map.create([
 *         ["a", 1],

package/dist/Map/set.d.ts

@@ -1,12 +1,14 @@
 //#region src/Map/set.d.ts
 /**
- * `Map.set(map, key, value)`
- *
- * Sets the `value` for the specified `key` in `map`, returning a new map if the value changes.
+ * ```ts
+ * function Map.set(map, key, value)
+ * ```
  *
  * ## Example
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * Map.set(
  *     Map.create([
  *         ["a", 1],
@@ -27,6 +29,8 @@
  * ```
  *
  * ```ts
+ * import { Map } from "@monstermann/map";
+ *
  * pipe(
  *     Map.create([
  *         ["a", 1],

package/dist/Map/set.js

@@ -3,13 +3,15 @@ import { cloneMap } from "@monstermann/remmi";
 
 //#region src/Map/set.ts
 /**
-* `Map.set(map, key, value)`
-*
-* Sets the `value` for the specified `key` in `map`, returning a new map if the value changes.
+* ```ts
+* function Map.set(map, key, value)
+* ```
 *
 * ## Example
 *
 * ```ts
+* import { Map } from "@monstermann/map";
+*
 * Map.set(
 *     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/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@monstermann/map",
     "type": "module",
-    "version": "0.0.0",
+    "version": "0.1.0",
     "description": "Functional utilities for maps.",
     "author": "Michael Ostermann <michaelostermann@me.com>",
     "license": "MIT",

package/dist/Map/isMap.d.ts

@@ -1,26 +0,0 @@
-//#region src/Map/isMap.d.ts
-/**
- * `Map.isMap(target)`
- *
- * Checks if `target` is a Map instance.
- *
- * ## Example
- *
- * ```ts
- * Map.isMap(Map.create()); // true
- * Map.isMap({}); // false
- * Map.isMap([]); // false
- * ```
- *
- * ```ts
- * pipe(Map.create(), Map.isMap()); // true
- * pipe({}, Map.isMap()); // false
- * pipe([], Map.isMap()); // false
- * ```
- */
-declare const isMap: {
-  (): (target: unknown) => target is Map<unknown, unknown>;
-  (target: unknown): target is Map<unknown, unknown>;
-};
-//#endregion
-export { isMap };

package/dist/Map/isMap.js

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