effect 4.0.1 → 4.0.2

package/src/HashMap.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
  */
 
@@ -44,6 +45,7 @@ const TypeId = internal.HashMapTypeId
  * HashMap.set(map, "d", 4) // => HashMap.make(["a", 1], ["b", 2], ["c", 3], ["d", 4])
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -85,6 +87,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 {
@@ -221,6 +224,7 @@ export declare namespace HashMap {
  * HashMap.isHashMap(null) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -241,6 +245,7 @@ export const isHashMap: {
    * HashMap.isHashMap(null) // => false
    * ```
    *
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -261,6 +266,7 @@ export const isHashMap: {
    * HashMap.isHashMap(null) // => false
    * ```
    *
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -278,6 +284,7 @@ export const isHashMap: {
  * HashMap.empty<string, number>() // => HashMap.empty()
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -294,6 +301,7 @@ export const empty: <K = never, V = never>() => HashMap<K, V> = internal.empty
  * HashMap.make(["a", 1], ["b", 2], ["c", 3]) // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -316,6 +324,7 @@ export 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
  */
@@ -336,6 +345,7 @@ export const fromIterable: <K, V>(entries: Iterable<readonly [K, V]>) => HashMap
  * HashMap.isEmpty(nonEmptyMap) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -359,6 +369,7 @@ export const isEmpty: <K, V>(self: HashMap<K, V>) => boolean = internal.isEmpty
  * HashMap.get("b")(map) // => Option.some(2)
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -381,6 +392,7 @@ export const get: {
    * HashMap.get("b")(map) // => Option.some(2)
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -403,6 +415,7 @@ export const get: {
    * HashMap.get("b")(map) // => Option.some(2)
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -434,6 +447,7 @@ export const get: {
  * HashMap.getHash(userMap, "user999", Hash.string("user999")) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -463,6 +477,7 @@ export const getHash: {
    * HashMap.getHash(userMap, "user999", Hash.string("user999")) // => Option.none()
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -492,6 +507,7 @@ export const getHash: {
    * HashMap.getHash(userMap, "user999", Hash.string("user999")) // => Option.none()
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -533,6 +549,7 @@ export const getHash: {
  * // Error: "HashMap.getUnsafe: key not found"
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -572,6 +589,7 @@ export const getUnsafe: {
    * // Error: "HashMap.getUnsafe: key not found"
    * ```
    *
+   * @stability stable
    * @category unsafe
    * @since 4.0.0
    */
@@ -611,6 +629,7 @@ export const getUnsafe: {
    * // Error: "HashMap.getUnsafe: key not found"
    * ```
    *
+   * @stability stable
    * @category unsafe
    * @since 4.0.0
    */
@@ -634,6 +653,7 @@ export const getUnsafe: {
  * HashMap.has("b")(map) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -655,6 +675,7 @@ export const has: {
    * HashMap.has("b")(map) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -676,6 +697,7 @@ export const has: {
    * HashMap.has("b")(map) // => true
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -709,6 +731,7 @@ export const has: {
  * HashMap.hasHash(userMap, "Admin", lowercaseHash) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -740,6 +763,7 @@ export const hasHash: {
    * HashMap.hasHash(userMap, "Admin", lowercaseHash) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -771,6 +795,7 @@ export const hasHash: {
    * HashMap.hasHash(userMap, "Admin", lowercaseHash) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -790,6 +815,7 @@ export const hasHash: {
  * HashMap.hasBy(hm, (value) => value === "b") // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 3.16.0
  */
@@ -807,6 +833,7 @@ export const hasBy: {
    * HashMap.hasBy(hm, (value) => value === "b") // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 3.16.0
    */
@@ -824,6 +851,7 @@ export const hasBy: {
    * HashMap.hasBy(hm, (value) => value === "b") // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 3.16.0
    */
@@ -849,6 +877,7 @@ export const hasBy: {
  * map1 // => HashMap.make(["a", 1])
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -869,6 +898,7 @@ export const set: {
    * map1 // => HashMap.make(["a", 1])
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -889,6 +919,7 @@ export const set: {
    * map1 // => HashMap.make(["a", 1])
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -907,6 +938,7 @@ export const set: {
  * Array.from(HashMap.keys(map)).sort() // => ["a", "b", "c"]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -924,6 +956,7 @@ export const keys: <K, V>(self: HashMap<K, V>) => IterableIterator<K> = internal
  * Array.from(HashMap.values(map)).sort() // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -954,6 +987,7 @@ export const values: <K, V>(self: HashMap<K, V>) => IterableIterator<V> = intern
  * allEmployees.filter((emp) => emp.department === "engineering").length // => 2
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.13.0
  */
@@ -985,6 +1019,7 @@ export const toValues = <K, V>(self: HashMap<K, V>): Array<V> => Array.from(valu
  * Array.from(HashMap.entries(config)).length // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1018,6 +1053,7 @@ export const entries: <K, V>(self: HashMap<K, V>) => IterableIterator<[K, V]> =
  * HashMap.fromIterable(scoreEntries) // => HashMap.make(["alice", 1250], ["charlie", 1100], ["bob", 980])
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1038,6 +1074,7 @@ export const toEntries = <K, V>(self: HashMap<K, V>): Array<[K, V]> => Array.fro
  * HashMap.size(map) // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -1070,6 +1107,7 @@ export const size: <K, V>(self: HashMap<K, V>) => number = internal.size
  * HashMap.endMutation(mutable) // => HashMap.make(["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1098,6 +1136,7 @@ export const beginMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V> = inter
  * HashMap.endMutation(mutable) // => HashMap.make(["y", 20], ["z", 30], ["w", 40])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1125,6 +1164,7 @@ export const endMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V> = interna
  * map2 // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1151,6 +1191,7 @@ export const mutate: {
    * map2 // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1177,6 +1218,7 @@ export const mutate: {
    * map2 // => HashMap.make(["a", 1], ["b", 2], ["c", 3])
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1207,6 +1249,7 @@ export const mutate: {
  * HashMap.get(updated, "a") // => Option.some(2)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1235,6 +1278,7 @@ export const modifyAt: {
    * HashMap.get(updated, "a") // => Option.some(2)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1263,6 +1307,7 @@ export const modifyAt: {
    * HashMap.get(updated, "a") // => Option.some(2)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1316,6 +1361,7 @@ export const modifyAt: {
  * HashMap.get(withClicks, "clicks") // => Option.some(1)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1367,6 +1413,7 @@ export const modifyHash: {
    * HashMap.get(withClicks, "clicks") // => Option.some(1)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1418,6 +1465,7 @@ export const modifyHash: {
    * HashMap.get(withClicks, "clicks") // => Option.some(1)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1439,6 +1487,7 @@ export const modifyHash: {
  * HashMap.get(map2, "b") // => Option.some(2)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1458,6 +1507,7 @@ export const modify: {
    * HashMap.get(map2, "b") // => Option.some(2)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1477,6 +1527,7 @@ export const modify: {
    * HashMap.get(map2, "b") // => Option.some(2)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1504,6 +1555,7 @@ export const modify: {
  * HashMap.get(union, "b") // => Option.some(20)
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -1529,6 +1581,7 @@ export const union: {
    * HashMap.get(union, "b") // => Option.some(20)
    * ```
    *
+   * @stability stable
    * @category combining
    * @since 2.0.0
    */
@@ -1554,6 +1607,7 @@ export const union: {
    * HashMap.get(union, "b") // => Option.some(20)
    * ```
    *
+   * @stability stable
    * @category combining
    * @since 2.0.0
    */
@@ -1575,6 +1629,7 @@ export const union: {
  * map2 // => HashMap.make(["a", 1], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1594,6 +1649,7 @@ export const remove: {
    * map2 // => HashMap.make(["a", 1], ["c", 3])
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1613,6 +1669,7 @@ export const remove: {
    * map2 // => HashMap.make(["a", 1], ["c", 3])
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1633,6 +1690,7 @@ export const remove: {
  * map2 // => HashMap.make(["a", 1], ["c", 3])
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1651,6 +1709,7 @@ export const removeMany: {
    * map2 // => HashMap.make(["a", 1], ["c", 3])
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1669,6 +1728,7 @@ export const removeMany: {
    * map2 // => HashMap.make(["a", 1], ["c", 3])
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 2.0.0
    */
@@ -1691,6 +1751,7 @@ export const removeMany: {
  * HashMap.get(map2, "a") // => Option.some(10)
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1711,6 +1772,7 @@ export const setMany: {
    * HashMap.get(map2, "a") // => Option.some(10)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -1731,6 +1793,7 @@ export const setMany: {
    * HashMap.get(map2, "a") // => Option.some(10)
    * ```
    *
+   * @stability stable
    * @category transforming
    * @since 4.0.0
    */
@@ -1752,6 +1815,7 @@ export const setMany: {
  * HashMap.get(map2, "b") // => Option.some("b:4")
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1771,6 +1835,7 @@ export const map: {
    * HashMap.get(map2, "b") // => Option.some("b:4")
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -1790,6 +1855,7 @@ export const map: {
    * HashMap.get(map2, "b") // => Option.some("b:4")
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -1818,6 +1884,7 @@ export const map: {
  * HashMap.get(map2, "b2") // => Option.some(4)
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -1844,6 +1911,7 @@ export const flatMap: {
    * HashMap.get(map2, "b2") // => Option.some(4)
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 2.0.0
    */
@@ -1870,6 +1938,7 @@ export const flatMap: {
    * HashMap.get(map2, "b2") // => Option.some(4)
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 2.0.0
    */
@@ -1894,6 +1963,7 @@ export const flatMap: {
  * collected.sort() // => [["a", 1], ["b", 2]]
  * ```
  *
+ * @stability stable
  * @category traversing
  * @since 2.0.0
  */
@@ -1916,6 +1986,7 @@ export const forEach: {
    * collected.sort() // => [["a", 1], ["b", 2]]
    * ```
    *
+   * @stability stable
    * @category traversing
    * @since 2.0.0
    */
@@ -1938,6 +2009,7 @@ export const forEach: {
    * collected.sort() // => [["a", 1], ["b", 2]]
    * ```
    *
+   * @stability stable
    * @category traversing
    * @since 2.0.0
    */
@@ -1956,6 +2028,7 @@ export const forEach: {
  * HashMap.reduce(map, 0, (acc, value) => acc + value) // => 6
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -1972,6 +2045,7 @@ export const reduce: {
    * HashMap.reduce(map, 0, (acc, value) => acc + value) // => 6
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -1988,6 +2062,7 @@ export const reduce: {
    * HashMap.reduce(map, 0, (acc, value) => acc + value) // => 6
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -2008,6 +2083,7 @@ export const reduce: {
  * map2 // => HashMap.make(["b", 2], ["d", 4])
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -2026,6 +2102,7 @@ export const filter: {
    * map2 // => HashMap.make(["b", 2], ["d", 4])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -2044,6 +2121,7 @@ export const filter: {
    * map2 // => HashMap.make(["b", 2], ["d", 4])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -2069,6 +2147,7 @@ export const filter: {
  * HashMap.get(map2, "a") // => Option.some(1)
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -2093,6 +2172,7 @@ export const compact: <K, A>(self: HashMap<K, Option<A>>) => HashMap<K, A> = int
  * HashMap.get(map2, "b") // => Option.some(4)
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -2116,6 +2196,7 @@ export const filterMap: {
    * HashMap.get(map2, "b") // => Option.some(4)
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -2139,6 +2220,7 @@ export const filterMap: {
    * HashMap.get(map2, "b") // => Option.some(4)
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -2158,6 +2240,7 @@ export const filterMap: {
  * HashMap.findFirst(map, (value, key) => key === "b" && value > 1) // => Option.some(["b", 2])
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -2175,6 +2258,7 @@ export const findFirst: {
    * HashMap.findFirst(map, (value, key) => key === "b" && value > 1) // => Option.some(["b", 2])
    * ```
    *
+   * @stability stable
    * @category searching
    * @since 2.0.0
    */
@@ -2192,6 +2276,7 @@ export const findFirst: {
    * HashMap.findFirst(map, (value, key) => key === "b" && value > 1) // => Option.some(["b", 2])
    * ```
    *
+   * @stability stable
    * @category searching
    * @since 2.0.0
    */
@@ -2212,6 +2297,7 @@ export const findFirst: {
  * HashMap.some(map, (value) => value > 5) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 3.13.0
  */
@@ -2230,6 +2316,7 @@ export const some: {
    * HashMap.some(map, (value) => value > 5) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 3.13.0
    */
@@ -2248,6 +2335,7 @@ export const some: {
    * HashMap.some(map, (value) => value > 5) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 3.13.0
    */
@@ -2268,6 +2356,7 @@ export const some: {
  * HashMap.every(map, (value) => value > 1) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 3.14.0
  */
@@ -2286,6 +2375,7 @@ export const every: {
    * HashMap.every(map, (value) => value > 1) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 3.14.0
    */
@@ -2304,6 +2394,7 @@ export const every: {
    * HashMap.every(map, (value) => value > 1) // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 3.14.0
    */