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

package/dist/RefSubject/RefDuration.js

@@ -8,10 +8,21 @@ import * as RefSubject from "./RefSubject.js";
 /**
  * Creates a new `RefDuration` from a Duration, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates duration 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, Duration } from "effect"
- * import * as RefDuration from "effect/typed/fx/RefSubject/RefDuration"
+ * import * as RefDuration from "@typed/fx/RefDuration"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefDuration.make(Duration.seconds(5))
@@ -31,6 +42,17 @@ export function make(initial) {
 // ========================================
 /**
  * Add a Duration to the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Add a Duration to the current state of a RefDuration. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The add 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
  */
@@ -39,6 +61,17 @@ export const add = dual(2, function add(ref, that) {
 });
 /**
  * Subtract a Duration from the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Subtract a Duration from the current state of a RefDuration. The operation remains attached to
+ * the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The subtract 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
  */
@@ -47,6 +80,17 @@ export const subtract = dual(2, function subtract(ref, that) {
 });
 /**
  * Multiply the current state of a RefDuration by a number.
+ * @remarks
+ * ## Why
+ *
+ * Multiply the current state of a RefDuration by a number. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The multiply 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
  */
@@ -55,6 +99,17 @@ export const multiply = dual(2, function multiply(ref, that) {
 });
 /**
  * Divide the current state of a RefDuration by a number.
+ * @remarks
+ * ## Why
+ *
+ * Divide the current state of a RefDuration by a number. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The divide 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
  */
@@ -63,12 +118,34 @@ export const divide = dual(2, function divide(ref, that) {
 });
 /**
  * Check if the current state of a RefDuration is zero.
+ * @remarks
+ * ## Why
+ *
+ * Check if the current state of a RefDuration is zero. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is zero 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 isZero = (ref) => RefSubject.map(ref, Duration.isZero);
 /**
  * Check if the current state of a RefDuration is less than a Duration.
+ * @remarks
+ * ## Why
+ *
+ * Check if the current state of a RefDuration is less than a Duration. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is less than 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
  */
@@ -77,6 +154,17 @@ export const isLessThan = dual(2, function isLessThan(ref, that) {
 });
 /**
  * Check if the current state of a RefDuration is greater than a Duration.
+ * @remarks
+ * ## Why
+ *
+ * Check if the current state of a RefDuration is greater than a Duration. The operation remains
+ * attached to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The is greater than 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
  */
@@ -85,30 +173,85 @@ export const isGreaterThan = dual(2, function isGreaterThan(ref, that) {
 });
 /**
  * Get the milliseconds value of the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Get the milliseconds value of the current state of a RefDuration. The operation remains attached
+ * to the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The millis 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 millis = (ref) => RefSubject.map(ref, Duration.toMillis);
 /**
  * Get the seconds value of the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Get the seconds value of the current state of a RefDuration. The operation remains attached to
+ * the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The seconds 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 seconds = (ref) => RefSubject.map(ref, Duration.toSeconds);
 /**
  * Get the minutes value of the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Get the minutes value of the current state of a RefDuration. The operation remains attached to
+ * the RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The minutes 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 minutes = (ref) => RefSubject.map(ref, Duration.toMinutes);
 /**
  * Get the hours value of the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Get the hours value of the current state of a RefDuration. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The hours 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 hours = (ref) => RefSubject.map(ref, Duration.toHours);
 /**
  * Get the days value of the current state of a RefDuration.
+ * @remarks
+ * ## Why
+ *
+ * Get the days value of the current state of a RefDuration. The operation remains attached to the
+ * RefSubject's versioned state boundary.
+ *
+ * ## Ownership and lifetime
+ *
+ * The days 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
  */