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

package/dist/RefSubject/RefArray.d.ts

@@ -22,7 +22,7 @@ import * as RefSubject from "./RefSubject.js";
  * interruption, and Scope requirements expressed by its members.
  *
  * @since 1.18.0
- * @category models
+ * @category State models
  */
 export interface RefArray<in out A, in out E = never, out R = never> extends RefSubject.RefSubject<ReadonlyArray<A>, E, R> {
 }
@@ -63,7 +63,7 @@ export interface RefArray<in out A, in out E = never, out R = never> extends Ref
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export declare function make<A, E = never, R = never>(initial: ReadonlyArray<A> | Effect.Effect<ReadonlyArray<A>, E, R> | Fx.Fx<ReadonlyArray<A>, E, R>, eq?: Equivalence<A>): Effect.Effect<RefArray<A, E>, never, R | Scope.Scope>;
 /**
@@ -80,7 +80,7 @@ export declare function make<A, E = never, R = never>(initial: ReadonlyArray<A>
  * 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 prepend: {
     <A>(value: A): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -100,7 +100,7 @@ export declare const prepend: {
  * 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 prependAll: {
     <A>(value: Iterable<A>): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -120,7 +120,7 @@ export declare const prependAll: {
  * 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 append: {
     <A>(value: A): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -140,7 +140,7 @@ export declare const append: {
  * 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 appendAll: {
     <A>(value: Iterable<A>): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -160,7 +160,7 @@ export declare const appendAll: {
  * acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const drop: {
     (n: number): <A, E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -180,7 +180,7 @@ export declare const drop: {
  * 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 dropRight: {
     (n: number): <A, E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -200,7 +200,7 @@ export declare const dropRight: {
  * 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 dropWhile: {
     <A>(predicate: (a: A) => boolean): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -220,7 +220,7 @@ export declare const dropWhile: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const filterValues: {
     <A>(predicate: (a: A) => boolean): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<ReadonlyArray<A>, E, R>;
@@ -240,7 +240,7 @@ export declare const filterValues: {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const getIndex: {
     (index: number): <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Filtered<A, E, R>;
@@ -260,7 +260,7 @@ export declare const getIndex: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const groupBy: {
     <A>(f: (a: A) => string): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<R, E, Record<string, ReadonlyArray<A>>>;
@@ -280,7 +280,7 @@ export declare const groupBy: {
  * 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 insertAt: {
     <A>(index: number, a: A): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -300,7 +300,7 @@ export declare const insertAt: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export declare const isEmpty: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -317,7 +317,7 @@ export declare const isEmpty: <A, E, R>(ref: RefArray<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 isNonEmpty: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -334,7 +334,7 @@ export declare const isNonEmpty: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const length: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<number, E, R>;
 /**
@@ -357,7 +357,7 @@ export declare const length: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Com
  * changing that signature or runtime behavior requires a separate compatibility decision.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const map: {
     <A>(f: (a: A, index: number) => A): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<ReadonlyArray<A>, E, R>;
@@ -377,7 +377,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 mapValues: {
     <A, B>(f: (a: A, index: number) => B): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<ReadonlyArray<B>, E, R>;
@@ -397,7 +397,7 @@ export declare const mapValues: {
  * 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 modifyAt: {
     <A>(index: number, f: (a: A) => A): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -417,7 +417,7 @@ export declare const modifyAt: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const partition: {
     <A, B extends A>(predicate: (a: A) => a is B): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<R, E, readonly [ReadonlyArray<B>, ReadonlyArray<A>]>;
@@ -437,7 +437,7 @@ export declare const partition: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const reduce: {
     <A, B>(b: B, f: (b: B, a: A, index: number) => B): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<B, E, R>;
@@ -457,7 +457,7 @@ export declare const reduce: {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export declare const reduceRight: {
     <A, B>(b: B, f: (b: B, a: A, index: number) => B): <E, R>(ref: RefArray<A, E, R>) => RefSubject.Computed<B, E, R>;
@@ -477,7 +477,7 @@ export declare const reduceRight: {
  * 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 replaceAt: {
     <A>(index: number, a: A): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -497,7 +497,7 @@ export declare const replaceAt: {
  * 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 rotate: {
     (n: number): <A, E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -517,7 +517,7 @@ export declare const rotate: {
  * 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 sortBy: {
     <A>(orders: Iterable<Order.Order<A>>): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -537,7 +537,7 @@ export declare const sortBy: {
  * acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const take: {
     (n: number): <A, E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -557,7 +557,7 @@ export declare const take: {
  * 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 takeRight: {
     (n: number): <A, E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -577,7 +577,7 @@ export declare const takeRight: {
  * 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 takeWhile: {
     <A>(predicate: (a: A) => boolean): <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
@@ -597,7 +597,7 @@ export declare const takeWhile: {
  * 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 dedupeWith: <A>(valueEq: Equivalence<A>) => <E, R>(ref: RefArray<A, E, R>) => Effect.Effect<ReadonlyArray<A>, E, R>;
 /**
@@ -633,7 +633,7 @@ export declare const dedupeWith: <A>(valueEq: Equivalence<A>) => <E, R>(ref: Ref
  * ```
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const last: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Filtered<A, E, R>;
 /**
@@ -669,7 +669,7 @@ export declare const last: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Filte
  * ```
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export declare const head: <A, E, R>(ref: RefArray<A, E, R>) => RefSubject.Filtered<A, E, R>;
 //# sourceMappingURL=RefArray.d.ts.map

package/dist/RefSubject/RefArray.js

@@ -46,7 +46,7 @@ import { Result } from "effect";
  * ```
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function make(initial, eq = equals) {
     return RefSubject.make(initial, { eq: Equivalence_.Array(eq) });
@@ -65,7 +65,7 @@ export function make(initial, eq = equals) {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const prepend = dual(2, function prepend(ref, value) {
     return RefSubject.update(ref, ReadonlyArray.prepend(value));
@@ -84,7 +84,7 @@ export const prepend = dual(2, function prepend(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 prependAll = dual(2, function prependAll(ref, value) {
     return RefSubject.update(ref, ReadonlyArray.prependAll(value));
@@ -103,7 +103,7 @@ export const prependAll = dual(2, function prependAll(ref, 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 append = dual(2, function append(ref, value) {
     return RefSubject.update(ref, ReadonlyArray.append(value));
@@ -122,7 +122,7 @@ export const append = dual(2, function append(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 appendAll = dual(2, function appendAll(ref, value) {
     return RefSubject.update(ref, ReadonlyArray.appendAll(value));
@@ -141,7 +141,7 @@ export const appendAll = dual(2, function appendAll(ref, value) {
  * acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const drop = dual(2, function drop(ref, n) {
     return RefSubject.update(ref, ReadonlyArray.drop(n));
@@ -160,7 +160,7 @@ export const drop = dual(2, function drop(ref, n) {
  * 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 dropRight = dual(2, function dropRight(ref, n) {
     return RefSubject.update(ref, ReadonlyArray.dropRight(n));
@@ -179,7 +179,7 @@ export const dropRight = dual(2, function dropRight(ref, n) {
  * 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 dropWhile = dual(2, function dropWhile(ref, predicate) {
     return RefSubject.update(ref, ReadonlyArray.dropWhile(predicate));
@@ -198,7 +198,7 @@ export const dropWhile = dual(2, function dropWhile(ref, predicate) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const filterValues = dual(2, function filterValues(ref, predicate) {
     return RefSubject.map(ref, ReadonlyArray.filter(predicate));
@@ -217,7 +217,7 @@ export const filterValues = dual(2, function filterValues(ref, predicate) {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const getIndex = dual(2, function getIndex(ref, index) {
     return RefSubject.filterMap(ref, ReadonlyArray.get(index));
@@ -236,7 +236,7 @@ export const getIndex = dual(2, function getIndex(ref, index) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const groupBy = dual(2, function groupBy(ref, f) {
     return RefSubject.map(ref, ReadonlyArray.groupBy(f));
@@ -255,7 +255,7 @@ export const groupBy = dual(2, function groupBy(ref, f) {
  * 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 insertAt = dual(3, function insertAt(ref, index, a) {
     return RefSubject.update(ref, (as) => Option.getOrElse(ReadonlyArray.insertAt(as, index, a), () => [...as, a]));
@@ -274,7 +274,7 @@ export const insertAt = dual(3, function insertAt(ref, index, a) {
  * 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, ReadonlyArray.isReadonlyArrayEmpty);
 /**
@@ -291,7 +291,7 @@ export const isEmpty = (ref) => RefSubject.map(ref, ReadonlyArray.isReadonlyArra
  * 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, ReadonlyArray.isReadonlyArrayNonEmpty);
 /**
@@ -308,7 +308,7 @@ export const isNonEmpty = (ref) => RefSubject.map(ref, ReadonlyArray.isReadonlyA
  * 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, ReadonlyArray.length);
 /**
@@ -331,7 +331,7 @@ export const length = (ref) => RefSubject.map(ref, ReadonlyArray.length);
  * changing that signature or runtime behavior requires a separate compatibility decision.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const map = dual(2, function mapValues(ref, f) {
     return RefSubject.update(ref, ReadonlyArray.map(f));
@@ -350,7 +350,7 @@ export const map = dual(2, function mapValues(ref, f) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const mapValues = dual(2, function mapValues(ref, f) {
     return RefSubject.map(ref, ReadonlyArray.map(f));
@@ -369,7 +369,7 @@ export const mapValues = dual(2, function mapValues(ref, f) {
  * 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 modifyAt = dual(3, function modifyAt(ref, index, f) {
     return RefSubject.update(ref, (values) => Option.getOrElse(ReadonlyArray.modify(values, index, f), () => values));
@@ -388,7 +388,7 @@ export const modifyAt = dual(3, function modifyAt(ref, index, f) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const partition = dual(2, function partition(ref, predicate) {
     return RefSubject.map(ref, (array) => ReadonlyArray.partition(array, Result.liftPredicate(predicate, Result.fail)));
@@ -407,7 +407,7 @@ export const partition = dual(2, function partition(ref, predicate) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const reduce = dual(3, function reduce(ref, b, f) {
     return RefSubject.map(ref, ReadonlyArray.reduce(b, f));
@@ -426,7 +426,7 @@ export const reduce = dual(3, function reduce(ref, b, f) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const reduceRight = dual(3, function reduceRight(ref, b, f) {
     return RefSubject.map(ref, ReadonlyArray.reduceRight(b, f));
@@ -445,7 +445,7 @@ export const reduceRight = dual(3, function reduceRight(ref, b, f) {
  * 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 replaceAt = dual(3, function replaceAt(ref, index, a) {
     return RefSubject.update(ref, (values) => Option.getOrElse(ReadonlyArray.replace(values, index, a), () => values));
@@ -464,7 +464,7 @@ export const replaceAt = dual(3, function replaceAt(ref, index, a) {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const rotate = dual(2, function rotate(ref, n) {
     return RefSubject.update(ref, ReadonlyArray.rotate(n));
@@ -483,7 +483,7 @@ export const rotate = dual(2, function rotate(ref, n) {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const sortBy = dual(2, function sortBy(ref, orders) {
     return RefSubject.update(ref, ReadonlyArray.sortBy(...orders));
@@ -502,7 +502,7 @@ export const sortBy = dual(2, function sortBy(ref, orders) {
  * acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const take = dual(2, function take(ref, n) {
     return RefSubject.update(ref, ReadonlyArray.take(n));
@@ -521,7 +521,7 @@ export const take = dual(2, function take(ref, n) {
  * 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 takeRight = dual(2, function takeRight(ref, n) {
     return RefSubject.update(ref, ReadonlyArray.takeRight(n));
@@ -540,7 +540,7 @@ export const takeRight = dual(2, function takeRight(ref, n) {
  * 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 takeWhile = dual(2, function takeWhile(ref, predicate) {
     return RefSubject.update(ref, ReadonlyArray.takeWhile(predicate));
@@ -559,7 +559,7 @@ export const takeWhile = dual(2, function takeWhile(ref, predicate) {
  * 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 dedupeWith = (valueEq) => (ref) => RefSubject.update(ref, ReadonlyArray.dedupeWith(valueEq));
 /**
@@ -595,7 +595,7 @@ export const dedupeWith = (valueEq) => (ref) => RefSubject.update(ref, ReadonlyA
  * ```
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const last = (ref) => RefSubject.filterMap(ref, ReadonlyArray.last);
 /**
@@ -631,6 +631,6 @@ export const last = (ref) => RefSubject.filterMap(ref, ReadonlyArray.last);
  * ```
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const head = (ref) => RefSubject.filterMap(ref, ReadonlyArray.head);