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

package/dist/RefSubject/RefGraph.js

@@ -20,7 +20,7 @@ import * as RefSubject from "./RefSubject.js";
  * and cleanup; source failures and services stay on reads and pushes.
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function make(initial) {
     return RefSubject.make(initial, { eq: equals });
@@ -39,7 +39,7 @@ export function make(initial) {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function directed() {
     return RefSubject.make(Graph.directed(), { eq: equals });
@@ -58,7 +58,7 @@ export function directed() {
  * value. It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category constructors
+ * @category Constructors
  */
 export function undirected() {
     return RefSubject.make(Graph.undirected(), { eq: equals });
@@ -80,7 +80,7 @@ export function undirected() {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const addNode = dual(2, function addNode(ref, data) {
     return RefSubject.update(ref, (g) => {
@@ -103,7 +103,7 @@ export const addNode = dual(2, function addNode(ref, data) {
  * 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 removeNode = dual(2, function removeNode(ref, nodeIndex) {
     return RefSubject.update(ref, (g) => {
@@ -126,7 +126,7 @@ export const removeNode = dual(2, function removeNode(ref, nodeIndex) {
  * 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 updateNode = dual(3, function updateNode(ref, nodeIndex, f) {
     return RefSubject.update(ref, (g) => {
@@ -149,7 +149,7 @@ export const updateNode = dual(3, function updateNode(ref, nodeIndex, 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 addEdge = dual(4, function addEdge(ref, source, target, data) {
     return RefSubject.update(ref, (g) => {
@@ -172,7 +172,7 @@ export const addEdge = dual(4, function addEdge(ref, source, target, data) {
  * 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 removeEdge = dual(2, function removeEdge(ref, edgeIndex) {
     return RefSubject.update(ref, (g) => {
@@ -195,7 +195,7 @@ export const removeEdge = dual(2, function removeEdge(ref, edgeIndex) {
  * 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 updateEdge = dual(3, function updateEdge(ref, edgeIndex, f) {
     return RefSubject.update(ref, (g) => {
@@ -217,7 +217,7 @@ export const updateEdge = dual(3, function updateEdge(ref, edgeIndex, f) {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed graph and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const mapNodes = dual(2, function mapNodes(ref, f) {
     return RefSubject.update(ref, (g) => {
@@ -239,7 +239,7 @@ export const mapNodes = dual(2, function mapNodes(ref, f) {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed graph and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const mapEdges = dual(2, function mapEdges(ref, f) {
     return RefSubject.update(ref, (g) => {
@@ -261,7 +261,7 @@ export const mapEdges = dual(2, function mapEdges(ref, f) {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed graph and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const filterNodes = dual(2, function filterNodes(ref, predicate) {
     return RefSubject.update(ref, (g) => {
@@ -283,7 +283,7 @@ export const filterNodes = dual(2, function filterNodes(ref, predicate) {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed graph and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const filterEdges = dual(2, function filterEdges(ref, predicate) {
     return RefSubject.update(ref, (g) => {
@@ -306,7 +306,7 @@ export const filterEdges = dual(2, function filterEdges(ref, predicate) {
  * It acquires no resource; failures and services remain those of the source ref.
  *
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export const reverse = (ref) => RefSubject.update(ref, (g) => {
     const mutable = Graph.beginMutation(g);
@@ -329,7 +329,7 @@ export const reverse = (ref) => RefSubject.update(ref, (g) => {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const nodeCount = (ref) => RefSubject.map(ref, Graph.nodeCount);
 /**
@@ -345,7 +345,7 @@ export const nodeCount = (ref) => RefSubject.map(ref, Graph.nodeCount);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const edgeCount = (ref) => RefSubject.map(ref, Graph.edgeCount);
 /**
@@ -362,7 +362,7 @@ export const edgeCount = (ref) => RefSubject.map(ref, Graph.edgeCount);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const hasNode = dual(2, function hasNode(ref, nodeIndex) {
     return RefSubject.map(ref, Graph.hasNode(nodeIndex));
@@ -381,7 +381,7 @@ export const hasNode = dual(2, function hasNode(ref, nodeIndex) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const hasEdge = dual(3, function hasEdge(ref, source, target) {
     return RefSubject.map(ref, Graph.hasEdge(source, target));
@@ -400,7 +400,7 @@ export const hasEdge = dual(3, function hasEdge(ref, source, target) {
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const neighbors = dual(2, function neighbors(ref, nodeIndex) {
     return RefSubject.map(ref, Graph.neighbors(nodeIndex));
@@ -419,7 +419,7 @@ export const neighbors = dual(2, function neighbors(ref, nodeIndex) {
  * once; Fx observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const neighborsDirected = dual(3, function neighborsDirected(ref, nodeIndex, direction) {
     return RefSubject.map(ref, Graph.neighborsDirected(nodeIndex, direction));
@@ -438,7 +438,7 @@ export const neighborsDirected = dual(3, function neighborsDirected(ref, nodeInd
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const isAcyclic = (ref) => RefSubject.map(ref, Graph.isAcyclic);
 /**
@@ -455,7 +455,7 @@ export const isAcyclic = (ref) => RefSubject.map(ref, Graph.isAcyclic);
  * observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category State predicates
  */
 export const isBipartite = (ref) => RefSubject.map(ref, Graph.isBipartite);
 /**
@@ -472,7 +472,7 @@ export const isBipartite = (ref) => RefSubject.map(ref, Graph.isBipartite);
  * once; Fx observation follows later pushes and its observing Scope owns subscription cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const connectedComponents = (ref) => RefSubject.map(ref, Graph.connectedComponents);
 /**
@@ -490,7 +490,7 @@ export const connectedComponents = (ref) => RefSubject.map(ref, Graph.connectedC
  * cleanup.
  *
  * @since 1.18.0
- * @category computed
+ * @category Derived queries
  */
 export const stronglyConnectedComponents = (ref) => RefSubject.map(ref, Graph.stronglyConnectedComponents);
 // ========================================
@@ -510,7 +510,7 @@ export const stronglyConnectedComponents = (ref) => RefSubject.map(ref, Graph.st
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const getNode = dual(2, function getNode(ref, nodeIndex) {
     return RefSubject.filterMap(ref, Graph.getNode(nodeIndex));
@@ -529,7 +529,7 @@ export const getNode = dual(2, function getNode(ref, nodeIndex) {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const getEdge = dual(2, function getEdge(ref, edgeIndex) {
     return RefSubject.filterMap(ref, (g) => Graph.getEdge(g, edgeIndex));
@@ -548,7 +548,7 @@ export const getEdge = dual(2, function getEdge(ref, edgeIndex) {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const findNode = dual(2, function findNode(ref, predicate) {
     return RefSubject.filterMap(ref, (g) => Graph.findNode(g, predicate));
@@ -567,7 +567,7 @@ export const findNode = dual(2, function findNode(ref, predicate) {
  * while absent; the observing Scope owns and finalizes its Fx subscription.
  *
  * @since 1.18.0
- * @category filtered
+ * @category Optional queries
  */
 export const findEdge = dual(2, function findEdge(ref, predicate) {
     return RefSubject.filterMap(ref, (g) => Graph.findEdge(g, predicate));

package/dist/RefSubject/RefHashMap.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 RefHashMap<in out K, in out V, in out E = never, out R = never> extends RefSubject.RefSubject<HashMap.HashMap<K, V>, E, R> {
 }
@@ -40,7 +40,7 @@ export interface RefHashMap<in out K, in out V, in out E = never, out R = 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, V, E = never, R = never>(initial: HashMap.HashMap<K, V> | Effect.Effect<HashMap.HashMap<K, V>, E, R> | Fx.Fx<HashMap.HashMap<K, V>, E, R>): Effect.Effect<RefHashMap<K, V, E>, never, R | Scope.Scope>;
 /**
@@ -57,7 +57,7 @@ export declare function make<K, V, E = never, R = never>(initial: HashMap.HashMa
  * 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 set: {
     <K, V>(key: K, value: V): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -77,7 +77,7 @@ export declare const set: {
  * 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 remove: {
     <K>(key: K): <V, E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -97,7 +97,7 @@ export declare const remove: {
  * 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 modify: {
     <K, V>(key: K, f: (v: V) => V): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -117,7 +117,7 @@ export declare const modify: {
  * 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: {
     <K, V>(key: K, f: HashMap.HashMap.UpdateFn<V>): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -137,7 +137,7 @@ export declare const modifyAt: {
  * 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 setMany: {
     <K, V>(entries: Iterable<readonly [K, V]>): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -157,7 +157,7 @@ export declare const setMany: {
  * 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 removeMany: {
     <K>(keys: Iterable<K>): <V, E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -177,7 +177,7 @@ export declare const removeMany: {
  * 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, V, E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
 /**
@@ -194,7 +194,7 @@ export declare const clear: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => Effect.
  * 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, V>(that: HashMap.HashMap<K, V>): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<K, V>, E, R>;
@@ -213,7 +213,7 @@ export declare const union: {
  * The Effect starts when run, participates in the source ref's serialized update boundary, and
  * acquires no resource. It returns the committed HashMap and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const filter: {
     <K, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<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 HashMap and retains the ref's E and R channels.
  * @since 1.18.0
- * @category combinators
+ * @category State updates
  */
 export declare const map: {
     <K, V>(f: (value: V, key: K) => V): <E, R>(ref: RefHashMap<K, V, E, R>) => Effect.Effect<HashMap.HashMap<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, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<number, E, R>;
 /**
@@ -269,7 +269,7 @@ export declare const size: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubje
  * 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, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -286,7 +286,7 @@ export declare const isEmpty: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSu
  * 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, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
 /**
@@ -303,7 +303,7 @@ export declare const isNonEmpty: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => Re
  * 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, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<Array<K>, E, R>;
 /**
@@ -320,7 +320,7 @@ export declare const keys: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubje
  * 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, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<Array<V>, E, R>;
 /**
@@ -337,7 +337,7 @@ export declare const values: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSub
  * 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, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<Array<[K, V]>, E, R>;
 /**
@@ -354,7 +354,7 @@ export declare const entries: <K, V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSu
  * 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>(key: K): <V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -374,7 +374,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 mapValues: {
     <K, V, B>(f: (value: V, key: K) => B): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<HashMap.HashMap<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 filterValues: {
     <K, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<HashMap.HashMap<K, V>, E, R>;
@@ -414,7 +414,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, V, B>(f: (value: V, key: K) => Option.Option<B>): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<HashMap.HashMap<K, B>, E, R>;
@@ -434,7 +434,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 reduce: {
     <K, V, B>(b: B, f: (b: B, value: V, key: K) => B): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<B, E, R>;
@@ -454,7 +454,7 @@ export declare const reduce: {
  * 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, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -474,7 +474,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, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Computed<boolean, E, R>;
@@ -494,7 +494,7 @@ export declare const every: {
  * 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>(key: K): <V, E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Filtered<V, E, R>;
@@ -514,7 +514,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, V>(predicate: (value: V, key: K) => boolean): <E, R>(ref: RefHashMap<K, V, E, R>) => RefSubject.Filtered<[K, V], E, R>;