effect 4.0.0 → 4.0.2

package/dist/HashMap.d.ts

@@ -7,6 +7,7 @@
  * batch updates. This module also includes constructors, iteration, conversion,
  * mapping, filtering, and reducing helpers.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type { Equal } from "./Equal.ts";
@@ -40,6 +41,7 @@ declare const TypeId = "~effect/HashMap";
  * HashMap.set(map, "d", 4) // => HashMap.make(["a", 1], ["b", 2], ["c", 3], ["d", 4])
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -80,6 +82,7 @@ export interface HashMap<out Key, out Value> extends Iterable<[Key, Value]>, Equ
  * updatedInventory // => HashMap.make(["laptop", { quantity: 5, price: 999 }], ["mouse", { quantity: 20, price: 29 }], ["tablet", newProduct])
  * ```
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace HashMap {
@@ -212,6 +215,7 @@ export declare namespace HashMap {
  * HashMap.isHashMap(null) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -232,6 +236,7 @@ export declare const isHashMap: {
      * HashMap.isHashMap(null) // => false
      * ```
      *
+     * @stability stable
      * @category guards
      * @since 2.0.0
      */
@@ -252,6 +257,7 @@ export declare const isHashMap: {
      * HashMap.isHashMap(null) // => false
      * ```
      *
+     * @stability stable
      * @category guards
      * @since 2.0.0
      */
@@ -268,6 +274,7 @@ export declare const isHashMap: {
  * HashMap.empty<string, number>() // => HashMap.empty()
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -283,6 +290,7 @@ export declare const empty: <K = never, V = never>() => HashMap<K, V>;
  * HashMap.make(["a", 1], ["b", 2], ["c", 3]) // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -299,6 +307,7 @@ export declare const make: <Entries extends ReadonlyArray<readonly [any, any]>>(
  * HashMap.fromIterable(entries) // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -318,6 +327,7 @@ export declare const fromIterable: <K, V>(entries: Iterable<readonly [K, V]>) =>
  * HashMap.isEmpty(nonEmptyMap) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -340,6 +350,7 @@ export declare const isEmpty: <K, V>(self: HashMap<K, V>) => boolean;
  * HashMap.get("b")(map) // => Option.some(2)
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -362,6 +373,7 @@ export declare const get: {
      * HashMap.get("b")(map) // => Option.some(2)
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -384,6 +396,7 @@ export declare const get: {
      * HashMap.get("b")(map) // => Option.some(2)
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -414,6 +427,7 @@ export declare const get: {
  * HashMap.getHash(userMap, "user999", Hash.string("user999")) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -443,6 +457,7 @@ export declare const getHash: {
      * HashMap.getHash(userMap, "user999", Hash.string("user999")) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -472,6 +487,7 @@ export declare const getHash: {
      * HashMap.getHash(userMap, "user999", Hash.string("user999")) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -512,6 +528,7 @@ export declare const getHash: {
  * // Error: "HashMap.getUnsafe: key not found"
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -551,6 +568,7 @@ export declare const getUnsafe: {
      * // Error: "HashMap.getUnsafe: key not found"
      * ```
      *
+     * @stability stable
      * @category unsafe
      * @since 4.0.0
      */
@@ -590,6 +608,7 @@ export declare const getUnsafe: {
      * // Error: "HashMap.getUnsafe: key not found"
      * ```
      *
+     * @stability stable
      * @category unsafe
      * @since 4.0.0
      */
@@ -612,6 +631,7 @@ export declare const getUnsafe: {
  * HashMap.has("b")(map) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -633,6 +653,7 @@ export declare const has: {
      * HashMap.has("b")(map) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -654,6 +675,7 @@ export declare const has: {
      * HashMap.has("b")(map) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -686,6 +708,7 @@ export declare const has: {
  * HashMap.hasHash(userMap, "Admin", lowercaseHash) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -717,6 +740,7 @@ export declare const hasHash: {
      * HashMap.hasHash(userMap, "Admin", lowercaseHash) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -748,6 +772,7 @@ export declare const hasHash: {
      * HashMap.hasHash(userMap, "Admin", lowercaseHash) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -766,6 +791,7 @@ export declare const hasHash: {
  * HashMap.hasBy(hm, (value) => value === "b") // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 3.16.0
  */
@@ -783,6 +809,7 @@ export declare const hasBy: {
      * HashMap.hasBy(hm, (value) => value === "b") // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 3.16.0
      */
@@ -800,6 +827,7 @@ export declare const hasBy: {
      * HashMap.hasBy(hm, (value) => value === "b") // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 3.16.0
      */
@@ -821,6 +849,7 @@ export declare const hasBy: {
  * map1 // => HashMap.make(["a", 1])
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -841,6 +870,7 @@ export declare const set: {
      * map1 // => HashMap.make(["a", 1])
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -861,6 +891,7 @@ export declare const set: {
      * map1 // => HashMap.make(["a", 1])
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -878,6 +909,7 @@ export declare const set: {
  * Array.from(HashMap.keys(map)).sort() // => ["a", "b", "c"]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -894,6 +926,7 @@ export declare const keys: <K, V>(self: HashMap<K, V>) => IterableIterator<K>;
  * Array.from(HashMap.values(map)).sort() // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -923,6 +956,7 @@ export declare const values: <K, V>(self: HashMap<K, V>) => IterableIterator<V>;
  * allEmployees.filter((emp) => emp.department === "engineering").length // => 2
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.13.0
  */
@@ -953,6 +987,7 @@ export declare const toValues: <K, V>(self: HashMap<K, V>) => Array<V>;
  * Array.from(HashMap.entries(config)).length // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -985,6 +1020,7 @@ export declare const entries: <K, V>(self: HashMap<K, V>) => IterableIterator<[K
  * HashMap.fromIterable(scoreEntries) // => HashMap.make(["alice", 1250], ["charlie", 1100], ["bob", 980])
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1004,6 +1040,7 @@ export declare const toEntries: <K, V>(self: HashMap<K, V>) => Array<[K, V]>;
  * HashMap.size(map) // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1035,6 +1072,7 @@ export declare const size: <K, V>(self: HashMap<K, V>) => number;
  * HashMap.endMutation(mutable) // => HashMap.make(["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1062,6 +1100,7 @@ export declare const beginMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V>
  * HashMap.endMutation(mutable) // => HashMap.make(["y", 20], ["z", 30], ["w", 40])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1088,6 +1127,7 @@ export declare const endMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V>;
  * map2 // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1114,6 +1154,7 @@ export declare const mutate: {
      * map2 // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
      * ```
      *
+     * @stability stable
      * @category mutations
      * @since 2.0.0
      */
@@ -1140,6 +1181,7 @@ export declare const mutate: {
      * map2 // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
      * ```
      *
+     * @stability stable
      * @category mutations
      * @since 2.0.0
      */
@@ -1169,6 +1211,7 @@ export declare const mutate: {
  * HashMap.get(updated, "a") // => Option.some(2)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1197,6 +1240,7 @@ export declare const modifyAt: {
      * HashMap.get(updated, "a") // => Option.some(2)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1225,6 +1269,7 @@ export declare const modifyAt: {
      * HashMap.get(updated, "a") // => Option.some(2)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1277,6 +1322,7 @@ export declare const modifyAt: {
  * HashMap.get(withClicks, "clicks") // => Option.some(1)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1328,6 +1374,7 @@ export declare const modifyHash: {
      * HashMap.get(withClicks, "clicks") // => Option.some(1)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1379,6 +1426,7 @@ export declare const modifyHash: {
      * HashMap.get(withClicks, "clicks") // => Option.some(1)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1399,6 +1447,7 @@ export declare const modifyHash: {
  * HashMap.get(map2, "b") // => Option.some(2)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1418,6 +1467,7 @@ export declare const modify: {
      * HashMap.get(map2, "b") // => Option.some(2)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1437,6 +1487,7 @@ export declare const modify: {
      * HashMap.get(map2, "b") // => Option.some(2)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1463,6 +1514,7 @@ export declare const modify: {
  * HashMap.get(union, "b") // => Option.some(20)
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -1488,6 +1540,7 @@ export declare const union: {
      * HashMap.get(union, "b") // => Option.some(20)
      * ```
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -1513,6 +1566,7 @@ export declare const union: {
      * HashMap.get(union, "b") // => Option.some(20)
      * ```
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -1533,6 +1587,7 @@ export declare const union: {
  * map2 // => HashMap.make(["a", 1], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1552,6 +1607,7 @@ export declare const remove: {
      * map2 // => HashMap.make(["a", 1], ["c", 3])
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1571,6 +1627,7 @@ export declare const remove: {
      * map2 // => HashMap.make(["a", 1], ["c", 3])
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1590,6 +1647,7 @@ export declare const remove: {
  * map2 // => HashMap.make(["a", 1], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1608,6 +1666,7 @@ export declare const removeMany: {
      * map2 // => HashMap.make(["a", 1], ["c", 3])
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1626,6 +1685,7 @@ export declare const removeMany: {
      * map2 // => HashMap.make(["a", 1], ["c", 3])
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1647,6 +1707,7 @@ export declare const removeMany: {
  * HashMap.get(map2, "a") // => Option.some(10)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1667,6 +1728,7 @@ export declare const setMany: {
      * HashMap.get(map2, "a") // => Option.some(10)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 4.0.0
      */
@@ -1687,6 +1749,7 @@ export declare const setMany: {
      * HashMap.get(map2, "a") // => Option.some(10)
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 4.0.0
      */
@@ -1707,6 +1770,7 @@ export declare const setMany: {
  * HashMap.get(map2, "b") // => Option.some("b:4")
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1726,6 +1790,7 @@ export declare const map: {
      * HashMap.get(map2, "b") // => Option.some("b:4")
      * ```
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1745,6 +1810,7 @@ export declare const map: {
      * HashMap.get(map2, "b") // => Option.some("b:4")
      * ```
      *
+     * @stability stable
      * @category mapping
      * @since 2.0.0
      */
@@ -1772,6 +1838,7 @@ export declare const map: {
  * HashMap.get(map2, "b2") // => Option.some(4)
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -1798,6 +1865,7 @@ export declare const flatMap: {
      * HashMap.get(map2, "b2") // => Option.some(4)
      * ```
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1824,6 +1892,7 @@ export declare const flatMap: {
      * HashMap.get(map2, "b2") // => Option.some(4)
      * ```
      *
+     * @stability stable
      * @category sequencing
      * @since 2.0.0
      */
@@ -1847,6 +1916,7 @@ export declare const flatMap: {
  * collected.sort() // => [["a", 1], ["b", 2]]
  * ```
  *
+ * @stability stable
  * @category traversing
  * @since 2.0.0
  */
@@ -1869,6 +1939,7 @@ export declare const forEach: {
      * collected.sort() // => [["a", 1], ["b", 2]]
      * ```
      *
+     * @stability stable
      * @category traversing
      * @since 2.0.0
      */
@@ -1891,6 +1962,7 @@ export declare const forEach: {
      * collected.sort() // => [["a", 1], ["b", 2]]
      * ```
      *
+     * @stability stable
      * @category traversing
      * @since 2.0.0
      */
@@ -1908,6 +1980,7 @@ export declare const forEach: {
  * HashMap.reduce(map, 0, (acc, value) => acc + value) // => 6
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -1924,6 +1997,7 @@ export declare const reduce: {
      * HashMap.reduce(map, 0, (acc, value) => acc + value) // => 6
      * ```
      *
+     * @stability stable
      * @category folding
      * @since 2.0.0
      */
@@ -1940,6 +2014,7 @@ export declare const reduce: {
      * HashMap.reduce(map, 0, (acc, value) => acc + value) // => 6
      * ```
      *
+     * @stability stable
      * @category folding
      * @since 2.0.0
      */
@@ -1959,6 +2034,7 @@ export declare const reduce: {
  * map2 // => HashMap.make(["b", 2], ["d", 4])
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1977,6 +2053,7 @@ export declare const filter: {
      * map2 // => HashMap.make(["b", 2], ["d", 4])
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -1995,6 +2072,7 @@ export declare const filter: {
      * map2 // => HashMap.make(["b", 2], ["d", 4])
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -2019,6 +2097,7 @@ export declare const filter: {
  * HashMap.get(map2, "a") // => Option.some(1)
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -2042,6 +2121,7 @@ export declare const compact: <K, A>(self: HashMap<K, Option<A>>) => HashMap<K,
  * HashMap.get(map2, "b") // => Option.some(4)
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -2065,6 +2145,7 @@ export declare const filterMap: {
      * HashMap.get(map2, "b") // => Option.some(4)
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -2088,6 +2169,7 @@ export declare const filterMap: {
      * HashMap.get(map2, "b") // => Option.some(4)
      * ```
      *
+     * @stability stable
      * @category filtering
      * @since 2.0.0
      */
@@ -2106,6 +2188,7 @@ export declare const filterMap: {
  * HashMap.findFirst(map, (value, key) => key === "b" && value > 1) // => Option.some(["b", 2])
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -2123,6 +2206,7 @@ export declare const findFirst: {
      * HashMap.findFirst(map, (value, key) => key === "b" && value > 1) // => Option.some(["b", 2])
      * ```
      *
+     * @stability stable
      * @category searching
      * @since 2.0.0
      */
@@ -2140,6 +2224,7 @@ export declare const findFirst: {
      * HashMap.findFirst(map, (value, key) => key === "b" && value > 1) // => Option.some(["b", 2])
      * ```
      *
+     * @stability stable
      * @category searching
      * @since 2.0.0
      */
@@ -2159,6 +2244,7 @@ export declare const findFirst: {
  * HashMap.some(map, (value) => value > 5) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 3.13.0
  */
@@ -2177,6 +2263,7 @@ export declare const some: {
      * HashMap.some(map, (value) => value > 5) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 3.13.0
      */
@@ -2195,6 +2282,7 @@ export declare const some: {
      * HashMap.some(map, (value) => value > 5) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 3.13.0
      */
@@ -2214,6 +2302,7 @@ export declare const some: {
  * HashMap.every(map, (value) => value > 1) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 3.14.0
  */
@@ -2232,6 +2321,7 @@ export declare const every: {
      * HashMap.every(map, (value) => value > 1) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 3.14.0
      */
@@ -2250,6 +2340,7 @@ export declare const every: {
      * HashMap.every(map, (value) => value > 1) // => false
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 3.14.0
      */