@typed/fx 2.0.0-beta.1 → 2.0.0-beta.11

package/dist/RefSubject/RefResult.d.ts

@@ -10,18 +10,40 @@ import type * as Fx from "../Fx/index.js";
 import * as RefSubject from "./RefSubject.js";
 /**
  * A RefResult is a RefSubject specialized over a Result value.
+ * @remarks
+ * ## Why
+ *
+ * Defines result state with the same current-read, pushed-update, and synchronized-write contract
+ * as RefSubject.
+ *
+ * ## Ownership and lifetime
+ *
+ * RefResult 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
+ * @category State models
  */
-export interface RefResult<in out A, in out E, in out Err = never, out R = never> extends RefSubject.RefSubject<Result.Result<A, E>, Err, R> {
+export interface RefResult<in out A, in out ResultE, in out Err = never, out R = never> extends RefSubject.RefSubject<Result.Result<A, ResultE>, Err, R> {
 }
 /**
  * Creates a new `RefResult` from a Result, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates result 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, Result } from "effect"
- * import * as RefResult from "effect/typed/fx/RefSubject/RefResult"
+ * import * as RefResult from "@typed/fx/RefResult"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefResult.make(Result.succeed(42))
@@ -31,91 +53,201 @@ export interface RefResult<in out A, in out E, in out Err = never, out R = never
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
-export declare function make<A, E, Err = never, R = never>(initial: Result.Result<A, E> | Effect.Effect<Result.Result<A, E>, Err, R> | Fx.Fx<Result.Result<A, E>, Err, R>, successEq?: Equivalence<A>, failureEq?: Equivalence<E>): Effect.Effect<RefResult<A, E, Err, R>, never, R | Scope.Scope>;
+export declare function make<A, ResultE, Err = never, R = never>(initial: Result.Result<A, ResultE> | Effect.Effect<Result.Result<A, ResultE>, Err, R> | Fx.Fx<Result.Result<A, ResultE>, Err, R>, successEq?: Equivalence<A>, failureEq?: Equivalence<ResultE>): Effect.Effect<RefResult<A, ResultE, Err, R>, never, R | Scope.Scope>;
 /**
  * Set the current state of a RefResult to Success(value).
+ * @remarks
+ * ## Why
+ *
+ * Keeps set success atomic with respect to competing RefSubject writes instead of splitting the
+ * read and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set success performs one serialized result 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
+ * @category State updates
  */
 export declare const setSuccess: {
-    <A>(value: A): <E, R>(ref: RefResult<A, E, R>) => Effect.Effect<Result.Result<A, E>, E, R>;
-    <A, E, R>(ref: RefResult<A, E, R>, value: A): Effect.Effect<Result.Result<A, E>, E, R>;
+    <A>(value: A): <ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => Effect.Effect<Result.Result<A, ResultE>, Err, R>;
+    <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>, value: A): Effect.Effect<Result.Result<A, ResultE>, Err, R>;
 };
 /**
  * Set the current state of a RefResult to Failure(error).
+ * @remarks
+ * ## Why
+ *
+ * Keeps set failure atomic with respect to competing RefSubject writes instead of splitting the
+ * read and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set failure performs one serialized result 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
+ * @category State updates
  */
 export declare const setFailure: {
-    <E>(error: E): <A, R>(ref: RefResult<A, E, R>) => Effect.Effect<Result.Result<A, E>, E, R>;
-    <A, E, R>(ref: RefResult<A, E, R>, error: E): Effect.Effect<Result.Result<A, E>, E, R>;
+    <ResultE>(error: ResultE): <A, Err, R>(ref: RefResult<A, ResultE, Err, R>) => Effect.Effect<Result.Result<A, ResultE>, Err, R>;
+    <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>, error: ResultE): Effect.Effect<Result.Result<A, ResultE>, Err, R>;
 };
 /**
  * Map the success value of a RefResult.
+ * @remarks
+ * ## Why
+ *
+ * Projects result state with map for both current reads and future pushes, avoiding a second
+ * mutable cache of the derived value.
+ *
+ * ## Ownership and lifetime
+ *
+ * The map 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
+ * @category Derived queries
  */
 export declare const map: {
-    <A, B>(f: (a: A) => B): <E, R>(ref: RefResult<A, E, R>) => RefSubject.Computed<Result.Result<B, E>, E, R>;
-    <A, E, R, B>(ref: RefResult<A, E, R>, f: (a: A) => B): RefSubject.Computed<Result.Result<B, E>, E, R>;
+    <A, B>(f: (a: A) => B): <ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Computed<Result.Result<B, ResultE>, Err, R>;
+    <A, ResultE, Err, R, B>(ref: RefResult<A, ResultE, Err, R>, f: (a: A) => B): RefSubject.Computed<Result.Result<B, ResultE>, Err, R>;
 };
 /**
  * Map the error value of a RefResult.
+ * @remarks
+ * ## Why
+ *
+ * Projects result state with map error for both current reads and future pushes, avoiding a second
+ * mutable cache of the derived value.
+ *
+ * ## Ownership and lifetime
+ *
+ * The map error 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
+ * @category Derived queries
  */
 export declare const mapError: {
-    <E, E2>(f: (e: E) => E2): <A, R>(ref: RefResult<A, E, R>) => RefSubject.Computed<Result.Result<A, E2>, E, R>;
-    <A, E, R, E2>(ref: RefResult<A, E, R>, f: (e: E) => E2): RefSubject.Computed<Result.Result<A, E2>, E, R>;
+    <ResultE, ResultE2>(f: (e: ResultE) => ResultE2): <A, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Computed<Result.Result<A, ResultE2>, Err, R>;
+    <A, ResultE, Err, R, ResultE2>(ref: RefResult<A, ResultE, Err, R>, f: (e: ResultE) => ResultE2): RefSubject.Computed<Result.Result<A, ResultE2>, Err, R>;
 };
 /**
  * FlatMap the success value of a RefResult.
+ * @remarks
+ * ## Why
+ *
+ * Projects only successful values with `Result.flatMap` while preserving failures; current reads
+ * and future pushes use the same read-only derivation.
+ *
+ * ## Ownership and lifetime
+ *
+ * The flat map 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
+ * @category Derived queries
  */
 export declare const flatMap: {
-    <A, B, E2>(f: (a: A) => Result.Result<B, E2>): <E, R>(ref: RefResult<A, E, R>) => RefSubject.Computed<Result.Result<B, E | E2>, E, R>;
-    <A, E, R, B, E2>(ref: RefResult<A, E, R>, f: (a: A) => Result.Result<B, E2>): RefSubject.Computed<Result.Result<B, E | E2>, E, R>;
+    <A, B, ResultE2>(f: (a: A) => Result.Result<B, ResultE2>): <ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Computed<Result.Result<B, ResultE | ResultE2>, Err, R>;
+    <A, ResultE, Err, R, B, ResultE2>(ref: RefResult<A, ResultE, Err, R>, f: (a: A) => Result.Result<B, ResultE2>): RefSubject.Computed<Result.Result<B, ResultE | ResultE2>, Err, R>;
 };
 /**
  * Check if the current state of a RefResult is Success.
+ * @remarks
+ * ## Why
+ *
+ * Exposes the Result success discriminator as Computed state without changing or duplicating the
+ * RefResult.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is success 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
+ * @category State predicates
  */
-export declare const isSuccess: <A, E, Err, R>(ref: RefResult<A, E, Err, R>) => RefSubject.Computed<boolean, Err, R>;
+export declare const isSuccess: <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Computed<boolean, Err, R>;
 /**
  * Check if the current state of a RefResult is Failure.
+ * @remarks
+ * ## Why
+ *
+ * Exposes the Result failure discriminator as Computed state without changing or duplicating the
+ * RefResult.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is failure 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
+ * @category State predicates
  */
-export declare const isFailure: <A, E, Err, R>(ref: RefResult<A, E, Err, R>) => RefSubject.Computed<boolean, Err, R>;
+export declare const isFailure: <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Computed<boolean, Err, R>;
 /**
  * Match on the Result value.
+ * @remarks
+ * ## Why
+ *
+ * Folds both Result variants into one Computed value, applying the same handlers to current reads
+ * and subsequent pushes.
+ *
+ * ## Ownership and lifetime
+ *
+ * The match 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
+ * @category Derived queries
  */
 export declare const match: {
-    <A, E, B>(options: {
+    <A, ResultE, B>(options: {
         readonly onSuccess: (a: A) => B;
-        readonly onFailure: (e: E) => B;
-    }): <R>(ref: RefResult<A, E, R>) => RefSubject.Computed<B, E, R>;
-    <A, E, R, B>(ref: RefResult<A, E, R>, options: {
+        readonly onFailure: (e: ResultE) => B;
+    }): <Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Computed<B, Err, R>;
+    <A, ResultE, Err, R, B>(ref: RefResult<A, ResultE, Err, R>, options: {
         readonly onSuccess: (a: A) => B;
-        readonly onFailure: (e: E) => B;
-    }): RefSubject.Computed<B, E, R>;
+        readonly onFailure: (e: ResultE) => B;
+    }): RefSubject.Computed<B, Err, R>;
 };
 /**
  * Get the success value from the Result as a Filtered (fails if Failure).
+ * @remarks
+ * ## Why
+ *
+ * Models the possibly absent result of get success as Filtered state, so absence stays explicit
+ * while later source versions can make a value available.
+ *
+ * ## Ownership and lifetime
+ *
+ * The get success view retains no independent value. Its Effect read fails with NoSuchElement
+ * while absent; the observing Scope owns and finalizes its Fx subscription.
+ *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
-export declare const getSuccess: <A, E, Err, R>(ref: RefResult<A, E, Err, R>) => RefSubject.Filtered<A, Err, R>;
+export declare const getSuccess: <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Filtered<A, Err, R>;
 /**
  * Get the failure value from the Result as a Filtered (fails if Success).
+ * @remarks
+ * ## Why
+ *
+ * Models the possibly absent result of get failure as Filtered state, so absence stays explicit
+ * while later source versions can make a value available.
+ *
+ * ## Ownership and lifetime
+ *
+ * The get failure view retains no independent value. Its Effect read fails with NoSuchElement
+ * while absent; the observing Scope owns and finalizes its Fx subscription.
+ *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
-export declare const getFailure: <A, E, Err, R>(ref: RefResult<A, E, Err, R>) => RefSubject.Filtered<E, Err, R>;
+export declare const getFailure: <A, ResultE, Err, R>(ref: RefResult<A, ResultE, Err, R>) => RefSubject.Filtered<ResultE, Err, R>;
 //# sourceMappingURL=RefResult.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"RefResult.d.ts","sourceRoot":"","sources":["../../src/RefSubject/RefResult.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,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,SAAS,CACxB,EAAE,CAAC,GAAG,CAAC,CAAC,EACR,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,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;CAAG;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EAC/C,OAAO,EACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAC1C,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EACtC,SAAS,GAAE,WAAW,CAAC,CAAC,CAA8B,EACtD,SAAS,GAAE,WAAW,CAAC,CAAC,CAA8B,GACrD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAEhE;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAGvF,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAGvF,CAAC;AAMH;;;;GAIG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,CAAC,EAAE,CAAC,EACH,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACb,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrF,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACT,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACvB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACb,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAGlD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,CAAC,EAAE,EAAE,EACJ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,GACd,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACtF,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EACV,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACvB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,GACd,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAGnD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EACP,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,GAChC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1F,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EACb,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACvB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,GAChC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CASvD,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EACpC,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAC3B,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA0C,CAAC;AAEjF;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EACpC,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAC3B,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA0C,CAAC;AAEjF;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE;QACjB,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;KACjC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACT,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE;QACP,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;KACjC,GACA,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CAYjC,CAAC;AAMF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EACrC,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAC3B,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAiD,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EACrC,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,KAC3B,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAiD,CAAC"}
+{"version":3,"file":"RefResult.d.ts","sourceRoot":"","sources":["../../src/RefSubject/RefResult.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,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,SAAS,CACxB,EAAE,CAAC,GAAG,CAAC,CAAC,EACR,EAAE,CAAC,GAAG,CAAC,OAAO,EACd,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,KAAK,EAClB,GAAG,CAAC,CAAC,GAAG,KAAK,CACb,SAAQ,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;CAAG;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EACrD,OAAO,EACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,GACzB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAChD,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAC5C,SAAS,GAAE,WAAW,CAAC,CAAC,CAA8B,EACtD,SAAS,GAAE,WAAW,CAAC,OAAO,CAA8B,GAC3D,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAEtE;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,EACA,KAAK,EAAE,CAAC,GACP,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EACjB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EACjB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAClC,KAAK,EAAE,CAAC,GACP,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAGpD,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,OAAO,EACN,KAAK,EAAE,OAAO,GACb,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EACX,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EACjB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAClC,KAAK,EAAE,OAAO,GACb,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAQpD,CAAC;AAMH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,CAAC,EAAE,CAAC,EACH,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACb,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EACjB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAC/B,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EACpB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAClC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACb,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAS1D,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,OAAO,EAAE,QAAQ,EAChB,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,QAAQ,GAC1B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EACX,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAC/B,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAC3B,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAClC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,QAAQ,GAC1B,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAS3D,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EACb,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,GACtC,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EACjB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAC/B,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAC9B,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAClC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,GACtC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAUrE,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,OACrC,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KACjC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA0C,CAAC;AAEjF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,OACrC,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KACjC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAA0C,CAAC;AAEjF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE;QACvB,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC;KACvC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EACpB,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAClC,OAAO,EAAE;QACP,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC;KACvC,GACA,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;CAYnC,CAAC;AAMF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,OACtC,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KACjC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAiD,CAAC;AAElF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,OACtC,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,KACjC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAiD,CAAC"}

package/dist/RefSubject/RefResult.js

@@ -9,10 +9,21 @@ import * as RefSubject from "./RefSubject.js";
 /**
  * Creates a new `RefResult` from a Result, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates result 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, Result } from "effect"
- * import * as RefResult from "effect/typed/fx/RefSubject/RefResult"
+ * import * as RefResult from "@typed/fx/RefResult"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefResult.make(Result.succeed(42))
@@ -22,23 +33,45 @@ import * as RefSubject from "./RefSubject.js";
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function make(initial, successEq = Equivalence_.strictEqual(), failureEq = Equivalence_.strictEqual()) {
     return RefSubject.make(initial, { eq: Result.makeEquivalence(successEq, failureEq) });
 }
 /**
  * Set the current state of a RefResult to Success(value).
+ * @remarks
+ * ## Why
+ *
+ * Keeps set success atomic with respect to competing RefSubject writes instead of splitting the
+ * read and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set success performs one serialized result 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
+ * @category State updates
  */
 export const setSuccess = dual(2, function setSuccess(ref, value) {
     return RefSubject.set(ref, Result.succeed(value));
 });
 /**
  * Set the current state of a RefResult to Failure(error).
+ * @remarks
+ * ## Why
+ *
+ * Keeps set failure atomic with respect to competing RefSubject writes instead of splitting the
+ * read and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set failure performs one serialized result 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
+ * @category State updates
  */
 export const setFailure = dual(2, function setFailure(ref, error) {
     return RefSubject.set(ref, Result.fail(error));
@@ -48,44 +81,110 @@ export const setFailure = dual(2, function setFailure(ref, error) {
 // ========================================
 /**
  * Map the success value of a RefResult.
+ * @remarks
+ * ## Why
+ *
+ * Projects result state with map for both current reads and future pushes, avoiding a second
+ * mutable cache of the derived value.
+ *
+ * ## Ownership and lifetime
+ *
+ * The map 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
+ * @category Derived queries
  */
 export const map = dual(2, function map(ref, f) {
     return RefSubject.map(ref, (self) => Result.map(self, f));
 });
 /**
  * Map the error value of a RefResult.
+ * @remarks
+ * ## Why
+ *
+ * Projects result state with map error for both current reads and future pushes, avoiding a second
+ * mutable cache of the derived value.
+ *
+ * ## Ownership and lifetime
+ *
+ * The map error 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
+ * @category Derived queries
  */
 export const mapError = dual(2, function mapError(ref, f) {
     return RefSubject.map(ref, (self) => Result.mapError(self, f));
 });
 /**
  * FlatMap the success value of a RefResult.
+ * @remarks
+ * ## Why
+ *
+ * Projects only successful values with `Result.flatMap` while preserving failures; current reads
+ * and future pushes use the same read-only derivation.
+ *
+ * ## Ownership and lifetime
+ *
+ * The flat map 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
+ * @category Derived queries
  */
 export const flatMap = dual(2, function flatMap(ref, f) {
     return RefSubject.map(ref, (self) => Result.flatMap(self, f));
 });
 /**
  * Check if the current state of a RefResult is Success.
+ * @remarks
+ * ## Why
+ *
+ * Exposes the Result success discriminator as Computed state without changing or duplicating the
+ * RefResult.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is success 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
+ * @category State predicates
  */
 export const isSuccess = (ref) => RefSubject.map(ref, Result.isSuccess);
 /**
  * Check if the current state of a RefResult is Failure.
+ * @remarks
+ * ## Why
+ *
+ * Exposes the Result failure discriminator as Computed state without changing or duplicating the
+ * RefResult.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is failure 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
+ * @category State predicates
  */
 export const isFailure = (ref) => RefSubject.map(ref, Result.isFailure);
 /**
  * Match on the Result value.
+ * @remarks
+ * ## Why
+ *
+ * Folds both Result variants into one Computed value, applying the same handlers to current reads
+ * and subsequent pushes.
+ *
+ * ## Ownership and lifetime
+ *
+ * The match 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
+ * @category Derived queries
  */
 export const match = dual(2, function match(ref, options) {
     return RefSubject.map(ref, (self) => Result.match(self, options));
@@ -95,13 +194,35 @@ export const match = dual(2, function match(ref, options) {
 // ========================================
 /**
  * Get the success value from the Result as a Filtered (fails if Failure).
+ * @remarks
+ * ## Why
+ *
+ * Models the possibly absent result of get success as Filtered state, so absence stays explicit
+ * while later source versions can make a value available.
+ *
+ * ## Ownership and lifetime
+ *
+ * The get success view retains no independent value. Its Effect read fails with NoSuchElement
+ * while absent; the observing Scope owns and finalizes its Fx subscription.
+ *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const getSuccess = (ref) => RefSubject.filterMap(ref, Result.getSuccess);
 /**
  * Get the failure value from the Result as a Filtered (fails if Success).
+ * @remarks
+ * ## Why
+ *
+ * Models the possibly absent result of get failure as Filtered state, so absence stays explicit
+ * while later source versions can make a value available.
+ *
+ * ## Ownership and lifetime
+ *
+ * The get failure view retains no independent value. Its Effect read fails with NoSuchElement
+ * while absent; the observing Scope owns and finalizes its Fx subscription.
+ *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const getFailure = (ref) => RefSubject.filterMap(ref, Result.getFailure);