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

package/dist/RefSubject/RefString.js

@@ -34,7 +34,7 @@ const isRefStringDataFirst = (args) => RefSubject.isRefSubject(args[0]);
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function make(initial, eq = Equivalence_.strictEqual()) {
     return RefSubject.make(initial, { eq });
@@ -56,7 +56,7 @@ export function make(initial, eq = Equivalence_.strictEqual()) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const concat = dual(2, function concat(ref, that) {
     return RefSubject.map(ref, (self) => String_.concat(self, that));
@@ -75,7 +75,7 @@ export const concat = dual(2, function concat(ref, that) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const toUpperCase = (ref) => RefSubject.map(ref, String_.toUpperCase);
 /**
@@ -92,7 +92,7 @@ export const toUpperCase = (ref) => RefSubject.map(ref, String_.toUpperCase);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const toLowerCase = (ref) => RefSubject.map(ref, String_.toLowerCase);
 /**
@@ -109,7 +109,7 @@ export const toLowerCase = (ref) => RefSubject.map(ref, String_.toLowerCase);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const trim = (ref) => RefSubject.map(ref, String_.trim);
 /**
@@ -126,7 +126,7 @@ export const trim = (ref) => RefSubject.map(ref, String_.trim);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const trimStart = (ref) => RefSubject.map(ref, String_.trimStart);
 /**
@@ -143,7 +143,7 @@ export const trimStart = (ref) => RefSubject.map(ref, String_.trimStart);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const trimEnd = (ref) => RefSubject.map(ref, String_.trimEnd);
 /**
@@ -160,7 +160,7 @@ export const trimEnd = (ref) => RefSubject.map(ref, String_.trimEnd);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const replace = dual(3, function replace(ref, searchValue, replaceValue) {
     return RefSubject.map(ref, String_.replace(searchValue, replaceValue));
@@ -179,7 +179,7 @@ export const replace = dual(3, function replace(ref, searchValue, replaceValue)
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const replaceAll = dual(3, function replaceAll(ref, searchValue, replaceValue) {
     return RefSubject.map(ref, String_.replaceAll(searchValue, replaceValue));
@@ -198,7 +198,7 @@ export const replaceAll = dual(3, function replaceAll(ref, searchValue, replaceV
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const isEmpty = (ref) => RefSubject.map(ref, String_.isEmpty);
 /**
@@ -215,7 +215,7 @@ export const isEmpty = (ref) => RefSubject.map(ref, String_.isEmpty);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const isNonEmpty = (ref) => RefSubject.map(ref, String_.isNonEmpty);
 /**
@@ -232,7 +232,7 @@ export const isNonEmpty = (ref) => RefSubject.map(ref, String_.isNonEmpty);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const length = (ref) => RefSubject.map(ref, String_.length);
 /**
@@ -249,7 +249,7 @@ export const length = (ref) => RefSubject.map(ref, String_.length);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const startsWith = dual(isRefStringDataFirst, function startsWith(ref, searchString, position) {
     return RefSubject.map(ref, String_.startsWith(searchString, position));
@@ -268,7 +268,7 @@ export const startsWith = dual(isRefStringDataFirst, function startsWith(ref, se
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const endsWith = dual(isRefStringDataFirst, function endsWith(ref, searchString, position) {
     return RefSubject.map(ref, String_.endsWith(searchString, position));
@@ -287,7 +287,7 @@ export const endsWith = dual(isRefStringDataFirst, function endsWith(ref, search
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const includes = dual(isRefStringDataFirst, function includes(ref, searchString, position) {
     return RefSubject.map(ref, String_.includes(searchString, position));
@@ -306,7 +306,7 @@ export const includes = dual(isRefStringDataFirst, function includes(ref, search
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const slice = dual(isRefStringDataFirst, function slice(ref, start, end) {
     return RefSubject.map(ref, String_.slice(start, end));

package/dist/RefSubject/RefStruct.d.ts

@@ -21,7 +21,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 RefStruct<in out S extends object, in out E = never, out R = never> extends RefSubject.RefSubject<S, E, R> {
 }
@@ -52,7 +52,7 @@ export interface RefStruct<in out S extends object, in out E = never, out R = ne
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export declare function make<S extends object, E = never, R = never>(initial: S | Effect.Effect<S, E, R> | Fx.Fx<S, E, R>, eq?: Equivalence<S>): Effect.Effect<RefStruct<S, E>, never, R | Scope.Scope>;
 /**
@@ -69,7 +69,7 @@ export declare function make<S extends object, E = never, R = never>(initial: S
  * 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: {
     <S extends object, K extends keyof S>(key: K, value: S[K]): <E, R>(ref: RefStruct<S, E, R>) => Effect.Effect<S, E, R>;
@@ -89,7 +89,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 update: {
     <S extends object, K extends keyof S>(key: K, f: (value: S[K]) => S[K]): <E, R>(ref: RefStruct<S, E, R>) => Effect.Effect<S, E, R>;
@@ -109,7 +109,7 @@ export declare const update: {
  * 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 merge: {
     <O extends object>(that: O): <S extends object, E, R>(ref: RefStruct<S, E, R>) => Effect.Effect<S, E, R>;
@@ -129,7 +129,7 @@ export declare const merge: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const pick: {
     <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): <E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<Pick<S, Keys[number]>, E, R>;
@@ -149,7 +149,7 @@ export declare const pick: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const omit: {
     <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): <E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<Omit<S, Keys[number]>, E, R>;
@@ -181,7 +181,7 @@ export declare const omit: {
  * ```
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const get: {
     <S extends object, const K extends keyof S>(key: K): <E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<S[K], E, R>;
@@ -201,7 +201,7 @@ export declare const get: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const keys: <S extends object, E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<Array<keyof S & string>, E, R>;
 /**
@@ -218,7 +218,7 @@ export declare const keys: <S extends object, E, R>(ref: RefStruct<S, 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: <S extends object, E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<Array<S[keyof S]>, E, R>;
 /**
@@ -235,7 +235,7 @@ export declare const values: <S extends object, E, R>(ref: RefStruct<S, 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 entries: <S extends object, E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<Array<[keyof S, S[keyof S]]>, E, R>;
 /**
@@ -252,7 +252,7 @@ export declare const entries: <S extends object, E, R>(ref: RefStruct<S, 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 has: {
     <S extends object, const K extends keyof S>(key: K): <E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -272,7 +272,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 size: <S extends object, E, R>(ref: RefStruct<S, E, R>) => RefSubject.Computed<number, E, R>;
 //# sourceMappingURL=RefStruct.d.ts.map

package/dist/RefSubject/RefStruct.js

@@ -34,7 +34,7 @@ import * as RefSubject from "./RefSubject.js";
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function make(initial, eq = Equivalence_.make((a, b) => equals(a, b))) {
     return RefSubject.make(initial, { eq });
@@ -53,7 +53,7 @@ export function make(initial, eq = Equivalence_.make((a, b) => equals(a, b))) {
  * acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const set = dual(3, function set(ref, key, value) {
     return RefSubject.update(ref, (self) => Struct.assign(self, { [key]: value }));
@@ -72,7 +72,7 @@ export const set = dual(3, function set(ref, key, 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 update = dual(3, function update(ref, key, f) {
     return RefSubject.update(ref, (self) => Struct.evolve(self, { [key]: f }));
@@ -91,7 +91,7 @@ export const update = dual(3, function update(ref, key, f) {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const merge = dual(2, function merge(ref, that) {
     return RefSubject.update(ref, (self) => Struct.assign(self, that));
@@ -113,7 +113,7 @@ export const merge = dual(2, function merge(ref, that) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const pick = dual(2, function pick(ref, keys) {
     return RefSubject.map(ref, (self) => Struct.pick(self, keys));
@@ -132,7 +132,7 @@ export const pick = dual(2, function pick(ref, keys) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const omit = dual(2, function omit(ref, keys) {
     return RefSubject.map(ref, (self) => Struct.omit(self, keys));
@@ -163,7 +163,7 @@ export const omit = dual(2, function omit(ref, keys) {
  * ```
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const get = dual(2, function get(ref, key) {
     return RefSubject.map(ref, (self) => Struct.get(self, key));
@@ -182,7 +182,7 @@ export const get = dual(2, function get(ref, key) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const keys = (ref) => RefSubject.map(ref, Struct.keys);
 /**
@@ -199,7 +199,7 @@ export const keys = (ref) => RefSubject.map(ref, Struct.keys);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const values = (ref) => RefSubject.map(ref, (self) => Object.values(self));
 /**
@@ -216,7 +216,7 @@ export const values = (ref) => RefSubject.map(ref, (self) => Object.values(self)
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const entries = (ref) => RefSubject.map(ref, (self) => Object.entries(self));
 /**
@@ -233,7 +233,7 @@ export const entries = (ref) => RefSubject.map(ref, (self) => Object.entries(sel
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const has = dual(2, function has(ref, key) {
     return RefSubject.map(ref, (self) => key in self);
@@ -252,6 +252,6 @@ export const has = dual(2, function has(ref, key) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const size = (ref) => RefSubject.map(ref, (self) => Object.keys(self).length);