effect 4.0.0 → 4.0.2

package/dist/TxHashMap.d.ts

@@ -7,6 +7,7 @@
  * shared registries, counters, indexes, and other maps that need safe
  * read-modify-write sequences alongside related transactional state.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Effect from "./Effect.ts";
@@ -52,6 +53,7 @@ declare const TypeId = "~effect/TxHashMap";
  * await Effect.runPromise(program) // => 2
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -95,6 +97,7 @@ export interface TxHashMap<in out K, in out V> extends Inspectable, Pipeable {
  * await Effect.runPromise(program) // => Option.some({ stock: 3, price: 999 })
  * ```
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace TxHashMap {
@@ -221,6 +224,7 @@ export declare namespace TxHashMap {
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -252,6 +256,7 @@ export declare const empty: <K, V>() => Effect.Effect<TxHashMap<K, V>>;
  * await Effect.runPromise(program) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -287,6 +292,7 @@ export declare const make: <K, V>(...entries: Array<readonly [K, V]>) => Effect.
  * await Effect.runPromise(program)
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -316,6 +322,7 @@ export declare const fromIterable: <K, V>(entries: Iterable<readonly [K, V]>) =>
  * await Effect.runPromise(program) // => Option.some({ name: "Bob", role: "user" })
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -345,6 +352,7 @@ export declare const get: {
      * await Effect.runPromise(program) // => Option.some({ name: "Bob", role: "user" })
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -374,6 +382,7 @@ export declare const get: {
      * await Effect.runPromise(program) // => Option.some({ name: "Bob", role: "user" })
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -414,6 +423,7 @@ export declare const get: {
  * await Effect.runPromise(program) // => Option.some(8)
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -453,6 +463,7 @@ export declare const set: {
      * await Effect.runPromise(program) // => Option.some(8)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -492,6 +503,7 @@ export declare const set: {
      * await Effect.runPromise(program) // => Option.some(8)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -523,6 +535,7 @@ export declare const set: {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -553,6 +566,7 @@ export declare const has: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -583,6 +597,7 @@ export declare const has: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 2.0.0
      */
@@ -622,6 +637,7 @@ export declare const has: {
  * await Effect.runPromise(program) // => 2
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -660,6 +676,7 @@ export declare const remove: {
      * await Effect.runPromise(program) // => 2
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -698,6 +715,7 @@ export declare const remove: {
      * await Effect.runPromise(program) // => 2
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -737,6 +755,7 @@ export declare const remove: {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -770,6 +789,7 @@ export declare const clear: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<void>
  * await Effect.runPromise(program) // => 3
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -799,6 +819,7 @@ export declare const size: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<number
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -824,6 +845,7 @@ export declare const isEmpty: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<boo
  * await Effect.runPromise(program) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -873,6 +895,7 @@ export declare const isNonEmpty: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<
  * await Effect.runPromise(program) // => Option.some(500)
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -922,6 +945,7 @@ export declare const modify: {
      * await Effect.runPromise(program) // => Option.some(500)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -971,6 +995,7 @@ export declare const modify: {
      * await Effect.runPromise(program) // => Option.some(500)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1017,6 +1042,7 @@ export declare const modify: {
  * await Effect.runPromise(program) // => Option.some("content1.bak")
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1062,6 +1088,7 @@ export declare const modifyAt: {
      * await Effect.runPromise(program) // => Option.some("content1.bak")
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1107,6 +1134,7 @@ export declare const modifyAt: {
      * await Effect.runPromise(program) // => Option.some("content1.bak")
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1144,6 +1172,7 @@ export declare const modifyAt: {
  * await Effect.runPromise(program) // => ["alice: admin", "bob: user", "charlie: moderator"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -1178,6 +1207,7 @@ export declare const keys: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<Array<
  * await Effect.runPromise(program) // => 95
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -1203,6 +1233,7 @@ export declare const values: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<Arra
  * await Effect.runPromise(program) // => [["host", "localhost"], ["port", "3000"], ["ssl", "false"]]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1240,6 +1271,7 @@ export declare const entries: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<Arr
  * await Effect.runPromise(program) // => Option.some(45.2)
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1286,6 +1318,7 @@ export declare const snapshot: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<Ha
  * await Effect.runPromise(program) // => 5
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1332,6 +1365,7 @@ export declare const union: {
      * await Effect.runPromise(program) // => 5
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1378,6 +1412,7 @@ export declare const union: {
      * await Effect.runPromise(program) // => 5
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1426,6 +1461,7 @@ export declare const union: {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1473,6 +1509,7 @@ export declare const removeMany: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1520,6 +1557,7 @@ export declare const removeMany: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1584,6 +1622,7 @@ export declare const removeMany: {
  * await Effect.runPromise(program) // => Option.some({ price: 399, stock: 3 })
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1647,6 +1686,7 @@ export declare const setMany: {
      * await Effect.runPromise(program) // => Option.some({ price: 399, stock: 3 })
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1710,6 +1750,7 @@ export declare const setMany: {
      * await Effect.runPromise(program) // => Option.some({ price: 399, stock: 3 })
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1747,6 +1788,7 @@ export declare const setMany: {
  * await Effect.runPromise(program) // => Exit.succeed("Valid TxHashMap")
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1791,6 +1833,7 @@ export declare const isTxHashMap: <K, V>(value: unknown) => value is TxHashMap<K
  * await Effect.runPromise(program) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1835,6 +1878,7 @@ export declare const getHash: {
      * await Effect.runPromise(program) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1879,6 +1923,7 @@ export declare const getHash: {
      * await Effect.runPromise(program) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -1933,6 +1978,7 @@ export declare const getHash: {
  * await Effect.runPromise(program) // => ["Role admin: true", "Role user: true", "Role moderator: false"]
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -1986,6 +2032,7 @@ export declare const hasHash: {
      * await Effect.runPromise(program) // => ["Role admin: true", "Role user: true", "Role moderator: false"]
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -2039,6 +2086,7 @@ export declare const hasHash: {
      * await Effect.runPromise(program) // => ["Role admin: true", "Role user: true", "Role moderator: false"]
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -2088,6 +2136,7 @@ export declare const hasHash: {
  * await Effect.runPromise(program) // => Option.some({ name: "Alice", age: 30, active: true })
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -2136,6 +2185,7 @@ export declare const map: {
      * await Effect.runPromise(program) // => Option.some({ name: "Alice", age: 30, active: true })
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2184,6 +2234,7 @@ export declare const map: {
      * await Effect.runPromise(program) // => Option.some({ name: "Alice", age: 30, active: true })
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2237,6 +2288,7 @@ export declare const map: {
  * await Effect.runPromise(program)
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -2289,6 +2341,7 @@ export declare const filter: {
      * await Effect.runPromise(program)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2341,6 +2394,7 @@ export declare const filter: {
      * await Effect.runPromise(program)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2393,6 +2447,7 @@ export declare const filter: {
      * await Effect.runPromise(program)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2445,6 +2500,7 @@ export declare const filter: {
      * await Effect.runPromise(program)
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2493,6 +2549,7 @@ export declare const filter: {
  * await Effect.runPromise(program) // => { quarters: 4, total: 80000, max: 25000 }
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2540,6 +2597,7 @@ export declare const reduce: {
      * await Effect.runPromise(program) // => { quarters: 4, total: 80000, max: 25000 }
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -2587,6 +2645,7 @@ export declare const reduce: {
      * await Effect.runPromise(program) // => { quarters: 4, total: 80000, max: 25000 }
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -2648,6 +2707,7 @@ export declare const reduce: {
  * await Effect.runPromise(program) // => 3
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -2708,6 +2768,7 @@ export declare const filterMap: {
      * await Effect.runPromise(program) // => 3
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2768,6 +2829,7 @@ export declare const filterMap: {
      * await Effect.runPromise(program) // => 3
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -2811,6 +2873,7 @@ export declare const filterMap: {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -2853,6 +2916,7 @@ export declare const hasBy: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -2895,6 +2959,7 @@ export declare const hasBy: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -2934,6 +2999,7 @@ export declare const hasBy: {
  * await Effect.runPromise(program) // => Option.some(["task1", { priority: 1, assignee: "alice", completed: false }])
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -2972,6 +3038,7 @@ export declare const findFirst: {
      * await Effect.runPromise(program) // => Option.some(["task1", { priority: 1, assignee: "alice", completed: false }])
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -3010,6 +3077,7 @@ export declare const findFirst: {
      * await Effect.runPromise(program) // => Option.some(["task1", { priority: 1, assignee: "alice", completed: false }])
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -3052,6 +3120,7 @@ export declare const findFirst: {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -3093,6 +3162,7 @@ export declare const some: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -3134,6 +3204,7 @@ export declare const some: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -3176,6 +3247,7 @@ export declare const some: {
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */
@@ -3217,6 +3289,7 @@ export declare const every: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -3258,6 +3331,7 @@ export declare const every: {
      * await Effect.runPromise(program) // => true
      * ```
      *
+     * @stability stable
      * @category predicates
      * @since 4.0.0
      */
@@ -3293,6 +3367,7 @@ export declare const every: {
  * result // => ["access.log: 2048 bytes (info)", "debug.log: 512 bytes (debug)", "error.log: 1024 bytes (error)"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -3327,6 +3402,7 @@ export declare const forEach: {
      * result // => ["access.log: 2048 bytes (info)", "debug.log: 512 bytes (debug)", "error.log: 1024 bytes (error)"]
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -3361,6 +3437,7 @@ export declare const forEach: {
      * result // => ["access.log: 2048 bytes (info)", "debug.log: 512 bytes (debug)", "error.log: 1024 bytes (error)"]
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 2.0.0
      */
@@ -3413,6 +3490,7 @@ export declare const forEach: {
  * await Effect.runPromise(program) // => 4
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -3464,6 +3542,7 @@ export declare const flatMap: {
      * await Effect.runPromise(program) // => 4
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -3515,6 +3594,7 @@ export declare const flatMap: {
      * await Effect.runPromise(program) // => 4
      * ```
      *
+     * @stability stable
      * @category combinators
      * @since 4.0.0
      */
@@ -3562,6 +3642,7 @@ export declare const flatMap: {
  * await Effect.runPromise(program) // => [["alice", 30], ["charlie", 25], ["eve", 28]]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -3594,6 +3675,7 @@ export declare const compact: <K, A>(self: TxHashMap<K, Option.Option<A>>) => Ef
  * await Effect.runPromise(program) // => { language: "en-US", theme: "dark", timezone: "UTC" }
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -3632,6 +3714,7 @@ export declare const toEntries: <K, V>(self: TxHashMap<K, V>) => Effect.Effect<A
  * await Effect.runPromise(program) // => 1
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */