@typed/fx 2.0.0-beta.6 → 2.0.0-beta.8

package/dist/RefSubject/RefOption.d.ts

@@ -22,7 +22,7 @@ import * as RefSubject from "./RefSubject.js";
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 1.18.0
- * @category models
+ * @category State models
  */
 export interface RefOption<in out A, in out E = never, out R = never> extends RefSubject.RefSubject<Option.Option<A>, E, R> {
 }
@@ -53,7 +53,7 @@ export interface RefOption<in out A, in out E = never, out R = never> extends Re
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export declare function make<A, E = never, R = never>(initial: Option.Option<A> | Effect.Effect<Option.Option<A>, E, R> | Fx.Fx<Option.Option<A>, E, R>, eq?: Equivalence<A>): Effect.Effect<RefOption<A, E>, never, R | Scope.Scope>;
 /**
@@ -70,7 +70,7 @@ export declare function make<A, E = never, R = never>(initial: Option.Option<A>
  * 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 setSome: {
     <A>(value: A): <E, R>(ref: RefOption<A, E, R>) => Effect.Effect<Option.Option<A>, E, R>;
@@ -90,7 +90,7 @@ export declare const setSome: {
  * 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 setNone: <A, E, R>(ref: RefOption<A, E, R>) => Effect.Effect<Option.Option<A>, E, R>;
 /**
@@ -107,7 +107,7 @@ export declare const setNone: <A, E, R>(ref: RefOption<A, E, R>) => Effect.Effec
  * 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: RefOption<A, E, R>) => RefSubject.Computed<Option.Option<B>, E, R>;
@@ -127,7 +127,7 @@ export declare const map: {
  * 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>(f: (a: A) => Option.Option<B>): <E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<Option.Option<B>, E, R>;
@@ -147,7 +147,7 @@ export declare const flatMap: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const filter: {
     <A>(predicate: (a: A) => boolean): <E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<Option.Option<A>, E, R>;
@@ -167,7 +167,7 @@ export declare const filter: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const getOrElse: {
     <A>(fallback: () => A): <E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<A, E, R>;
@@ -187,7 +187,7 @@ export declare const getOrElse: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const isSome: <A, E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -204,7 +204,7 @@ export declare const isSome: <A, E, R>(ref: RefOption<A, E, R>) => RefSubject.Co
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const isNone: <A, E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -221,7 +221,7 @@ export declare const isNone: <A, E, R>(ref: RefOption<A, E, R>) => RefSubject.Co
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const contains: {
     <A>(value: A): <E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -241,7 +241,7 @@ export declare const contains: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const exists: {
     <A>(predicate: (a: A) => boolean): <E, R>(ref: RefOption<A, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -261,7 +261,7 @@ export declare const exists: {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const getValue: <A, E, R>(ref: RefOption<A, E, R>) => RefSubject.Filtered<A, E, R>;
 //# sourceMappingURL=RefOption.d.ts.map

package/dist/RefSubject/RefOption.js

@@ -33,7 +33,7 @@ import * as RefSubject from "./RefSubject.js";
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function make(initial, eq = Equivalence_.strictEqual()) {
     return RefSubject.make(initial, { eq: Option.makeEquivalence(eq) });
@@ -52,7 +52,7 @@ export function make(initial, eq = Equivalence_.strictEqual()) {
  * 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 setSome = dual(2, function setSome(ref, value) {
     return RefSubject.set(ref, Option.some(value));
@@ -71,7 +71,7 @@ export const setSome = dual(2, function setSome(ref, value) {
  * 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 setNone = (ref) => RefSubject.set(ref, Option.none());
 // ========================================
@@ -91,7 +91,7 @@ export const setNone = (ref) => RefSubject.set(ref, Option.none());
  * 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) => Option.map(self, f));
@@ -110,7 +110,7 @@ export const map = dual(2, function map(ref, f) {
  * 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) => Option.flatMap(self, f));
@@ -129,7 +129,7 @@ export const flatMap = dual(2, function flatMap(ref, f) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const filter = dual(2, function filter(ref, predicate) {
     return RefSubject.map(ref, (self) => Option.filter(self, predicate));
@@ -148,7 +148,7 @@ export const filter = dual(2, function filter(ref, predicate) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const getOrElse = dual(2, function getOrElse(ref, fallback) {
     return RefSubject.map(ref, (self) => Option.getOrElse(self, fallback));
@@ -167,7 +167,7 @@ export const getOrElse = dual(2, function getOrElse(ref, fallback) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const isSome = (ref) => RefSubject.map(ref, Option.isSome);
 /**
@@ -184,7 +184,7 @@ export const isSome = (ref) => RefSubject.map(ref, Option.isSome);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const isNone = (ref) => RefSubject.map(ref, Option.isNone);
 /**
@@ -201,7 +201,7 @@ export const isNone = (ref) => RefSubject.map(ref, Option.isNone);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const contains = dual(2, function contains(ref, value) {
     return RefSubject.map(ref, (self) => Option.contains(self, value));
@@ -220,7 +220,7 @@ export const contains = dual(2, function contains(ref, value) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const exists = dual(2, function exists(ref, predicate) {
     return RefSubject.map(ref, (self) => Option.exists(self, predicate));
@@ -242,6 +242,6 @@ export const exists = dual(2, function exists(ref, predicate) {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const getValue = (ref) => RefSubject.compact(ref);

package/dist/RefSubject/RefRecord.d.ts

@@ -22,7 +22,7 @@ import * as RefSubject from "./RefSubject.js";
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 1.18.0
- * @category models
+ * @category State models
  */
 export interface RefRecord<in out K extends string, in out V, in out E = never, out R = never> extends RefSubject.RefSubject<Record.ReadonlyRecord<K, V>, E, R> {
 }
@@ -40,7 +40,7 @@ export interface RefRecord<in out K extends string, in out V, in out E = never,
  * and cleanup; source failures and services stay on reads and pushes.
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export declare function make<K extends string, V, E = never, R = never>(initial: Record.ReadonlyRecord<K, V> | Effect.Effect<Record.ReadonlyRecord<K, V>, E, R> | Fx.Fx<Record.ReadonlyRecord<K, V>, E, R>): Effect.Effect<RefRecord<K, V, E>, never, R | Scope.Scope>;
 /**
@@ -57,7 +57,7 @@ export declare function make<K extends string, V, E = never, R = never>(initial:
  * acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const set: {
     <K extends string, V>(key: K, value: V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -77,7 +77,7 @@ export declare const set: {
  * 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 remove: {
     <K extends string>(key: K): <V, E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -97,7 +97,7 @@ export declare const remove: {
  * 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 modify: {
     <K extends string, V>(key: K, f: (v: V) => V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -117,7 +117,7 @@ export declare const modify: {
  * 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 replace: {
     <K extends string, V>(key: K, value: V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -137,7 +137,7 @@ export declare const replace: {
  * 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 clear: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
 /**
@@ -154,7 +154,7 @@ export declare const clear: <K extends string, V, E, R>(ref: RefRecord<K, V, E,
  * 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 union: {
     <K extends string, V>(that: Record.ReadonlyRecord<K, V>, combine?: (selfValue: V, thatValue: V) => V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -174,7 +174,7 @@ export declare const union: {
  * 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 intersection: {
     <K extends string, V>(that: Record.ReadonlyRecord<K, V>, combine?: (selfValue: V, thatValue: V) => V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -194,7 +194,7 @@ export declare const intersection: {
  * 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 difference: {
     <K extends string, V>(that: Record.ReadonlyRecord<K, V>): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -213,7 +213,7 @@ export declare const difference: {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed Record and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const filter: {
     <K extends string, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -232,7 +232,7 @@ export declare const filter: {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed Record and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const map: {
     <K extends string, V>(f: (value: V, key: K) => V): <E, R>(ref: RefRecord<K, V, E, R>) => Effect.Effect<Record.ReadonlyRecord<K, V>, E, R>;
@@ -252,7 +252,7 @@ export declare const map: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const size: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<number, E, R>;
 /**
@@ -269,7 +269,7 @@ export declare const size: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const isEmpty: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -286,7 +286,7 @@ export declare const isEmpty: <K extends string, V, E, R>(ref: RefRecord<K, V, E
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const isNonEmpty: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -303,7 +303,7 @@ export declare const isNonEmpty: <K extends string, V, E, R>(ref: RefRecord<K, V
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const has: {
     <K extends string>(key: K): <V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -323,7 +323,7 @@ export declare const has: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const keys: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Array<K>, E, R>;
 /**
@@ -340,7 +340,7 @@ export declare const keys: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const values: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Array<V>, E, R>;
 /**
@@ -357,7 +357,7 @@ export declare const values: <K extends string, V, E, R>(ref: RefRecord<K, V, E,
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const entries: <K extends string, V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Array<[K, V]>, E, R>;
 /**
@@ -374,7 +374,7 @@ export declare const entries: <K extends string, V, E, R>(ref: RefRecord<K, V, E
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const mapValues: {
     <K extends string, V, B>(f: (value: V, key: K) => B): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Record.ReadonlyRecord<K, B>, E, R>;
@@ -394,7 +394,7 @@ export declare const mapValues: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const mapKeys: {
     <K extends string, K2 extends string>(f: (key: K) => K2): <V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Record.ReadonlyRecord<K2, V>, E, R>;
@@ -414,7 +414,7 @@ export declare const mapKeys: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const mapEntries: {
     <K extends string, V, K2 extends string, B>(f: (value: V, key: K) => [K2, B]): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Record.ReadonlyRecord<K2, B>, E, R>;
@@ -434,7 +434,7 @@ export declare const mapEntries: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const filterValues: {
     <K extends string, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Record.ReadonlyRecord<K, V>, E, R>;
@@ -454,7 +454,7 @@ export declare const filterValues: {
  * Fx observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const filterMapValues: {
     <K extends string, V, B>(f: (value: V, key: K) => Option.Option<B>): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<Record.ReadonlyRecord<K, B>, E, R>;
@@ -473,7 +473,7 @@ export declare const filterMapValues: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const partition: {
     <K extends string, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<[Record.ReadonlyRecord<K, V>, Record.ReadonlyRecord<K, V>], E, R>;
@@ -493,7 +493,7 @@ export declare const partition: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const some: {
     <K extends string, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -513,7 +513,7 @@ export declare const some: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const every: {
     <K extends string, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -533,7 +533,7 @@ export declare const every: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const reduce: {
     <K extends string, V, B>(b: B, f: (b: B, value: V, key: K) => B): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Computed<B, E, R>;
@@ -553,7 +553,7 @@ export declare const reduce: {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const get: {
     <K extends string>(key: K): <V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Filtered<V, E, R>;
@@ -573,7 +573,7 @@ export declare const get: {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const findFirst: {
     <K extends string, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Filtered<[K, V], E, R>;
@@ -593,7 +593,7 @@ export declare const findFirst: {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const pop: {
     <K extends string>(key: K): <V, E, R>(ref: RefRecord<K, V, E, R>) => RefSubject.Filtered<[V, Record.ReadonlyRecord<K, V>], E, R>;