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

package/dist/RefSubject/RefTuple.js

@@ -10,10 +10,21 @@ import * as RefSubject from "./RefSubject.js";
 /**
  * Creates a new `RefTuple` from a tuple, `Effect`, or `Fx`.
  *
+ * @remarks
+ * ## Why
+ *
+ * Creates tuple 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, Tuple } from "effect"
- * import * as RefTuple from "effect/typed/fx/RefSubject/RefTuple"
+ * import * as RefTuple from "@typed/fx/RefTuple"
  *
  * const program = Effect.gen(function* () {
  *   const value = yield* RefTuple.make(Tuple.make(1, "hello", true))
@@ -30,6 +41,17 @@ export function make(initial, eq = Equivalence_.make((a, b) => equals(a, b))) {
 }
 /**
  * Set the value at a specific index in the current state of a RefTuple.
+ * @remarks
+ * ## Why
+ *
+ * Keeps set at atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running set at performs one serialized tuple 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
  */
@@ -42,6 +64,17 @@ export const setAt = dual(3, function setAt(ref, index, value) {
 });
 /**
  * Update the value at a specific index in the current state of a RefTuple using a function.
+ * @remarks
+ * ## Why
+ *
+ * Keeps update at atomic with respect to competing RefSubject writes instead of splitting the read
+ * and replacement into separate effects.
+ *
+ * ## Ownership and lifetime
+ *
+ * Running update at performs one serialized tuple 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
  */
@@ -53,6 +86,17 @@ export const updateAt = dual(3, function updateAt(ref, index, f) {
 // ========================================
 /**
  * Append an element to the end of the current state of a RefTuple.
+ * @remarks
+ * ## Why
+ *
+ * Expresses append element as one ordered tuple transition; readers never observe the intermediate
+ * collection used to build the result.
+ *
+ * ## Ownership and lifetime
+ *
+ * The append element 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
  */
@@ -61,23 +105,73 @@ export const appendElement = dual(2, function appendElement(ref, element) {
 });
 /**
  * Prepend an element to the beginning of the current state of a RefTuple.
+ * @remarks
+ * ## Why
+ *
+ * Expresses prepend element as one ordered tuple transition; readers never observe the
+ * intermediate collection used to build the result.
+ *
+ * ## Ownership and lifetime
+ *
+ * The prepend element 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 prependElement = dual(2, function prependElement(ref, element) {
     return RefSubject.map(ref, (self) => [element, ...self]);
 });
+/**
+ * Projects one statically valid tuple index as Computed state.
+ *
+ * @remarks
+ * ## Why
+ *
+ * The index is constrained to the tuple's known indices, so every current value has that element.
+ * The result is Computed, cannot become absent, and does not add `NoSuchElementError`.
+ *
+ * ## Ownership and lifetime
+ *
+ * The get 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 combinators
+ */
 export const get = dual(2, function get(ref, index) {
     return RefSubject.map(ref, (self) => Tuple.get(self, index));
 });
 /**
  * Get the length of the current state of a RefTuple.
+ * @remarks
+ * ## Why
+ *
+ * Makes length a live projection of the tuple; consumers can sample it now or observe it without
+ * copying the source state.
+ *
+ * ## Ownership and lifetime
+ *
+ * The length 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 length = (ref) => RefSubject.map(ref, (self) => self.length);
 /**
  * Pick elements at specific indices from the current state of a RefTuple.
+ * @remarks
+ * ## Why
+ *
+ * Projects tuple state with pick for both current reads and future pushes, avoiding a second
+ * mutable cache of the derived value.
+ *
+ * ## Ownership and lifetime
+ *
+ * The pick 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
  */
@@ -86,6 +180,17 @@ export const pick = dual(2, function pick(ref, indices) {
 });
 /**
  * Omit elements at specific indices from the current state of a RefTuple.
+ * @remarks
+ * ## Why
+ *
+ * Projects tuple state with omit for both current reads and future pushes, avoiding a second
+ * mutable cache of the derived value.
+ *
+ * ## Ownership and lifetime
+ *
+ * The omit 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/index.d.ts

@@ -19,4 +19,5 @@ export * as RefStruct from "./RefStruct.js";
 export * as RefSubject from "./RefSubject.js";
 export * as RefTrie from "./RefTrie.js";
 export * as RefTuple from "./RefTuple.js";
+export * from "./Hydration.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RefSubject/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RefSubject/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,cAAc,gBAAgB,CAAC"}

package/dist/RefSubject/index.js

@@ -19,3 +19,4 @@ export * as RefStruct from "./RefStruct.js";
 export * as RefSubject from "./RefSubject.js";
 export * as RefTrie from "./RefTrie.js";
 export * as RefTuple from "./RefTuple.js";
+export * from "./Hydration.js";

package/dist/RefSubject.d.ts

@@ -1,2 +1,3 @@
-export * from "./RefSubject/index.js";
+export * from "./RefSubject/Hydration.js";
+export * from "./RefSubject/RefSubject.js";
 //# sourceMappingURL=RefSubject.d.ts.map

package/dist/RefSubject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RefSubject.d.ts","sourceRoot":"","sources":["../src/RefSubject.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"RefSubject.d.ts","sourceRoot":"","sources":["../src/RefSubject.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC"}

package/dist/RefSubject.js

@@ -1 +1,2 @@
-export * from "./RefSubject/index.js";
+export * from "./RefSubject/Hydration.js";
+export * from "./RefSubject/RefSubject.js";

package/dist/RefTrie.d.ts

@@ -0,0 +1,2 @@
+export * from "./RefSubject/RefTrie.js";
+//# sourceMappingURL=RefTrie.d.ts.map

package/dist/RefTrie.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RefTrie.d.ts","sourceRoot":"","sources":["../src/RefTrie.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/RefTrie.js

@@ -0,0 +1 @@
+export * from "./RefSubject/RefTrie.js";

package/dist/RefTuple.d.ts

@@ -0,0 +1,2 @@
+export * from "./RefSubject/RefTuple.js";
+//# sourceMappingURL=RefTuple.d.ts.map

package/dist/RefTuple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RefTuple.d.ts","sourceRoot":"","sources":["../src/RefTuple.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/RefTuple.js

@@ -0,0 +1 @@
+export * from "./RefSubject/RefTuple.js";