@typed/fx 2.0.0-beta.3 → 2.0.0-beta.5

package/dist/RefSubject/RefBoolean.js

@@ -9,10 +9,21 @@ import * as RefSubject from "./RefSubject.js";
 /**
  * Creates a new `RefBoolean` from a boolean, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates boolean state with equality suited to that Effect data type, so unchanged values do not
+ * produce redundant pushed updates.
+ *
+ * ## Ownership and lifetime
+ *
+ * The creation Effect requires Scope. It owns initializer acquisition, live source subscriptions,
+ * and cleanup; source failures and services stay on reads and pushes.
+ *
  * @example
  * ```ts
  * import { Effect } from "effect"
- * import * as RefBoolean from "effect/typed/fx/RefSubject/RefBoolean"
+ * import * as RefBoolean from "@typed/fx/RefBoolean"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefBoolean.make(true)
@@ -29,18 +40,51 @@ export function make(initial, eq = Equivalence_.strictEqual()) {
 }
 /**
  * Toggle the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Keeps toggle atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running toggle performs one serialized boolean transition and resolves with its committed value.
+ * It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
 export const toggle = (ref) => RefSubject.update(ref, Boolean_.not);
 /**
  * Set the current state of a RefBoolean to true.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set true atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set true performs one serialized boolean transition and resolves with its committed
+ * value. It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
 export const setTrue = (ref) => RefSubject.set(ref, true);
 /**
  * Set the current state of a RefBoolean to false.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set false atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set false performs one serialized boolean transition and resolves with its committed
+ * value. It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -50,6 +94,17 @@ export const setFalse = (ref) => RefSubject.set(ref, false);
 // ========================================
 /**
  * Apply AND operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply AND operation with a boolean to the current state of a RefBoolean. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The and view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -58,6 +113,17 @@ export const and = dual(2, function and(ref, that) {
 });
 /**
  * Apply OR operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply OR operation with a boolean to the current state of a RefBoolean. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The or view retains no independent state. An Effect read samples the source once; Fx observation
+ * follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -66,12 +132,34 @@ export const or = dual(2, function or(ref, that) {
 });
 /**
  * Apply NOT operation to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply NOT operation to the current state of a RefBoolean. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The not view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const not = (ref) => RefSubject.map(ref, Boolean_.not);
 /**
  * Apply XOR operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply XOR operation with a boolean to the current state of a RefBoolean. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The xor view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -80,6 +168,17 @@ export const xor = dual(2, function xor(ref, that) {
 });
 /**
  * Apply NAND operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply NAND operation with a boolean to the current state of a RefBoolean. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The nand view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -88,6 +187,17 @@ export const nand = dual(2, function nand(ref, that) {
 });
 /**
  * Apply NOR operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply NOR operation with a boolean to the current state of a RefBoolean. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The nor view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -96,6 +206,17 @@ export const nor = dual(2, function nor(ref, that) {
 });
 /**
  * Apply EQV (XNOR) operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply EQV (XNOR) operation with a boolean to the current state of a RefBoolean. The operation
+ * remains attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The eqv view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -104,6 +225,17 @@ export const eqv = dual(2, function eqv(ref, that) {
 });
 /**
  * Apply implication operation with a boolean to the current state of a RefBoolean.
+ * @remarks
+ * ## Why
+ *
+ * Apply implication operation with a boolean to the current state of a RefBoolean. The operation
+ * remains attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The implies view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
@@ -112,12 +244,34 @@ export const implies = dual(2, function implies(ref, that) {
 });
 /**
  * Check if the current state of a RefBoolean is true.
+ * @remarks
+ * ## Why
+ *
+ * Check if the current state of a RefBoolean is true. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is true view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const isTrue = (ref) => RefSubject.map(ref, (self) => self === true);
 /**
  * Check if the current state of a RefBoolean is false.
+ * @remarks
+ * ## Why
+ *
+ * Check if the current state of a RefBoolean is false. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is false view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */

package/dist/RefSubject/RefCause.d.ts

@@ -10,6 +10,17 @@ import type * as Fx from "../Fx/index.js";
 import * as RefSubject from "./RefSubject.js";
 /**
  * A RefCause is a RefSubject specialized over a Cause value.
+ * @remarks
+ * ## Why
+ *
+ * Defines cause state with the same current-read, pushed-update, and synchronized-write contract
+ * as RefSubject.
+ *
+ * ## Ownership and lifetime
+ *
+ * RefCause is a contract and performs no acquisition. Implementations retain the errors, services,
+ * interruption, and Scope requirements expressed by its members.
+ *
  * @since 1.18.0
  * @category models
  */
@@ -18,10 +29,21 @@ export interface RefCause<in out E, in out Err = never, out R = never> extends R
 /**
  * Creates a new `RefCause` from a Cause, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates cause state with equality suited to that Effect data type, so unchanged values do not
+ * produce redundant pushed updates.
+ *
+ * ## Ownership and lifetime
+ *
+ * The creation Effect requires Scope. It owns initializer acquisition, live source subscriptions,
+ * and cleanup; source failures and services stay on reads and pushes.
+ *
  * @example
  * ```ts
  * import { Effect, Cause } from "effect"
- * import * as RefCause from "effect/typed/fx/RefSubject/RefCause"
+ * import * as RefCause from "@typed/fx/RefCause"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefCause.make(Cause.fail("error"))
@@ -36,6 +58,17 @@ export interface RefCause<in out E, in out Err = never, out R = never> extends R
 export declare function make<E = never, Err = never, R = never>(initial: Cause.Cause<E> | Effect.Effect<Cause.Cause<E>, Err, R> | Fx.Fx<Cause.Cause<E>, Err, R>, eq?: Equivalence<Cause.Cause<E>>): Effect.Effect<RefCause<E, Err>, never, R | Scope.Scope>;
 /**
  * Set the current state of a RefCause to a Fail cause.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set fail atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set fail performs one serialized cause transition and resolves with its committed value.
+ * It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -45,6 +78,17 @@ export declare const setFail: {
 };
 /**
  * Set the current state of a RefCause to a Die cause.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set die atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set die performs one serialized cause transition and resolves with its committed value.
+ * It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -54,6 +98,17 @@ export declare const setDie: {
 };
 /**
  * Set the current state of a RefCause to an Interrupt cause.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set interrupt atomic with respect to competing RefSubject writes instead of splitting the
+ * read and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set interrupt performs one serialized cause transition and resolves with its committed
+ * value. It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -63,36 +118,102 @@ export declare const setInterrupt: {
 };
 /**
  * Check if the current state of a RefCause has a Fail.
+ * @remarks
+ * ## Why
+ *
+ * Makes has fails a live projection of the cause; consumers can sample it now or observe it
+ * without copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The has fails view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export declare const hasFails: <E, Err, R>(ref: RefCause<E, Err, R>) => RefSubject.Computed<boolean, Err, R>;
 /**
  * Check if the current state of a RefCause has a Die.
+ * @remarks
+ * ## Why
+ *
+ * Makes has dies a live projection of the cause; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The has dies view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export declare const hasDies: <E, Err, R>(ref: RefCause<E, Err, R>) => RefSubject.Computed<boolean, Err, R>;
 /**
  * Check if the current state of a RefCause has an Interrupt.
+ * @remarks
+ * ## Why
+ *
+ * Makes has interrupts a live projection of the cause; consumers can sample it now or observe it
+ * without copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The has interrupts view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export declare const hasInterrupts: <E, Err, R>(ref: RefCause<E, Err, R>) => RefSubject.Computed<boolean, Err, R>;
 /**
  * Check if the current state of a RefCause is empty.
+ * @remarks
+ * ## Why
+ *
+ * Makes is empty a live projection of the cause; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is empty view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export declare const isEmpty: <E, Err, R>(ref: RefCause<E, Err, R>) => RefSubject.Computed<boolean, Err, R>;
 /**
  * Get the size (number of failures) of the current state of a RefCause.
+ * @remarks
+ * ## Why
+ *
+ * Makes size a live projection of the cause; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The size view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export declare const size: <E, Err, R>(ref: RefCause<E, Err, R>) => RefSubject.Computed<number, Err, R>;
 /**
  * Get the reasons array of the current state of a RefCause.
+ * @remarks
+ * ## Why
+ *
+ * Get the reasons array of the current state of a RefCause. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The reasons view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */

package/dist/RefSubject/RefCause.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RefCause.d.ts","sourceRoot":"","sources":["../../src/RefSubject/RefCause.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAG7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,QAAQ,CACvB,EAAE,CAAC,GAAG,CAAC,CAAC,EACR,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,KAAK,EAClB,GAAG,CAAC,CAAC,GAAG,KAAK,CACb,SAAQ,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;CAAG;AAE1D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EACpD,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAC/F,EAAE,GAAE,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAU,GACvC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAEzD;AAED;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAGvF,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB,CAAC,MAAM,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAClG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAG9F,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB,CACE,OAAO,CAAC,EAAE,MAAM,GACf,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAG/F,CAAC;AAMH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAChC,KAAK,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAwC,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAC/B,KAAK,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAuC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EACrC,KAAK,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA6C,CAAC;AAEpF;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAC/B,KAAK,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA6D,CAAC;AAEpG;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CACzC,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAC/B,KAAK,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAChB,CAAC"}
+{"version":3,"file":"RefCause.d.ts","sourceRoot":"","sources":["../../src/RefSubject/RefCause.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAG7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,QAAQ,CACvB,EAAE,CAAC,GAAG,CAAC,CAAC,EACR,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,KAAK,EAClB,GAAG,CAAC,CAAC,GAAG,KAAK,CACb,SAAQ,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;CAAG;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EACpD,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAC/F,EAAE,GAAE,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAU,GACvC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAEzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAGvF,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB,CAAC,MAAM,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAClG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAG9F,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB,CACE,OAAO,CAAC,EAAE,MAAM,GACf,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAG/F,CAAC;AAMH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,OAC3B,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAwC,CAAC;AAE/E;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,OAC1B,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAuC,CAAC;AAE9E;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,OAChC,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA6C,CAAC;AAEpF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,OAC1B,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA6D,CAAC;AAEpG;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CACzC,CAAC;AAErD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,GAAG,EAAE,CAAC,OAC1B,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KACvB,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAChB,CAAC"}

package/dist/RefSubject/RefCause.js

@@ -10,10 +10,21 @@ import * as RefSubject from "./RefSubject.js";
 /**
  * Creates a new `RefCause` from a Cause, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates cause state with equality suited to that Effect data type, so unchanged values do not
+ * produce redundant pushed updates.
+ *
+ * ## Ownership and lifetime
+ *
+ * The creation Effect requires Scope. It owns initializer acquisition, live source subscriptions,
+ * and cleanup; source failures and services stay on reads and pushes.
+ *
  * @example
  * ```ts
  * import { Effect, Cause } from "effect"
- * import * as RefCause from "effect/typed/fx/RefSubject/RefCause"
+ * import * as RefCause from "@typed/fx/RefCause"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefCause.make(Cause.fail("error"))
@@ -30,6 +41,17 @@ export function make(initial, eq = equals) {
 }
 /**
  * Set the current state of a RefCause to a Fail cause.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set fail atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set fail performs one serialized cause transition and resolves with its committed value.
+ * It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -38,6 +60,17 @@ export const setFail = dual(2, function setFail(ref, error) {
 });
 /**
  * Set the current state of a RefCause to a Die cause.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set die atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set die performs one serialized cause transition and resolves with its committed value.
+ * It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -46,6 +79,17 @@ export const setDie = dual(2, function setDie(ref, defect) {
 });
 /**
  * Set the current state of a RefCause to an Interrupt cause.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set interrupt atomic with respect to competing RefSubject writes instead of splitting the
+ * read and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set interrupt performs one serialized cause transition and resolves with its committed
+ * value. It acquires no resource; failures and services remain those of the source ref.
+ *
  * @since 1.18.0
  * @category combinators
  */
@@ -57,36 +101,102 @@ export const setInterrupt = dual(2, function setInterrupt(ref, fiberId) {
 // ========================================
 /**
  * Check if the current state of a RefCause has a Fail.
+ * @remarks
+ * ## Why
+ *
+ * Makes has fails a live projection of the cause; consumers can sample it now or observe it
+ * without copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The has fails view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const hasFails = (ref) => RefSubject.map(ref, Cause.hasFails);
 /**
  * Check if the current state of a RefCause has a Die.
+ * @remarks
+ * ## Why
+ *
+ * Makes has dies a live projection of the cause; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The has dies view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const hasDies = (ref) => RefSubject.map(ref, Cause.hasDies);
 /**
  * Check if the current state of a RefCause has an Interrupt.
+ * @remarks
+ * ## Why
+ *
+ * Makes has interrupts a live projection of the cause; consumers can sample it now or observe it
+ * without copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The has interrupts view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const hasInterrupts = (ref) => RefSubject.map(ref, Cause.hasInterrupts);
 /**
  * Check if the current state of a RefCause is empty.
+ * @remarks
+ * ## Why
+ *
+ * Makes is empty a live projection of the cause; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is empty view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const isEmpty = (ref) => RefSubject.map(ref, (self) => self.reasons.length === 0);
 /**
  * Get the size (number of failures) of the current state of a RefCause.
+ * @remarks
+ * ## Why
+ *
+ * Makes size a live projection of the cause; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The size view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */
 export const size = (ref) => RefSubject.map(ref, (self) => self.reasons.length);
 /**
  * Get the reasons array of the current state of a RefCause.
+ * @remarks
+ * ## Why
+ *
+ * Get the reasons array of the current state of a RefCause. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The reasons view retains no independent state. An Effect read samples the source once; Fx
+ * observation follows later pushes and its observing Scope owns subscription cleanup.
+ *
  * @since 1.18.0
  * @category computed
  */