effect 4.0.0-beta.73 → 4.0.0-beta.74

package/dist/Effect.js

@@ -430,7 +430,7 @@ export const whileLoop = internal.whileLoop;
  * ```
  *
  * @see {@link tryPromise} for a version that can handle failures.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const promise = internal.promise;
@@ -496,7 +496,7 @@ export const promise = internal.promise;
  * ```
  *
  * @see {@link promise} if the effectful computation is asynchronous and does not throw errors.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const tryPromise = internal.tryPromise;
@@ -521,7 +521,7 @@ export const tryPromise = internal.tryPromise;
  * ```
  *
  * @see {@link fail} to create an effect that represents a failure.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const succeed = internal.succeed;
@@ -539,7 +539,7 @@ export const succeed = internal.succeed;
  * // Output: { _id: 'Option', _tag: 'None' }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const succeedNone = internal.succeedNone;
@@ -557,7 +557,7 @@ export const succeedNone = internal.succeedNone;
  * // Output: { _id: 'Option', _tag: 'Some', value: 42 }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const succeedSome = internal.succeedSome;
@@ -644,7 +644,7 @@ export const succeedSome = internal.succeedSome;
  *   )
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const suspend = internal.suspend;
@@ -680,7 +680,7 @@ export const suspend = internal.suspend;
  * ```
  *
  * @see {@link try_ | try} for a version that can handle failures.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const sync = internal.sync;
@@ -689,7 +689,7 @@ export {
 /**
  * Returns an effect that succeeds with `void`.
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 void_ as void };
@@ -698,7 +698,7 @@ export {
 /**
  * Returns an effect that succeeds with `undefined`.
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 undefined_ as undefined };
@@ -734,7 +734,7 @@ undefined_ as undefined };
  * const program = delay(1000)
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 export const callback = internal.callback;
@@ -757,7 +757,7 @@ export const callback = internal.callback;
  * const timedProgram = Effect.timeout(program, "1 second")
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const never = internal.never;
@@ -899,7 +899,7 @@ export const bind = internal.bind;
  * })
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const gen = internal.gen;
@@ -927,7 +927,7 @@ export const gen = internal.gen;
  * ```
  *
  * @see {@link succeed} to create an effect that represents a successful value.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const fail = internal.fail;
@@ -955,7 +955,7 @@ export const fail = internal.fail;
  * // Output: { _id: 'Exit', _tag: 'Failure', cause: ... }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const failSync = internal.failSync;
@@ -980,7 +980,7 @@ export const failSync = internal.failSync;
  * // Output: { _id: 'Exit', _tag: 'Failure', cause: ... }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const failCause = internal.failCause;
@@ -1008,7 +1008,7 @@ export const failCause = internal.failCause;
  * // Output: { _id: 'Exit', _tag: 'Failure', cause: ... }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const failCauseSync = internal.failCauseSync;
@@ -1049,7 +1049,7 @@ export const failCauseSync = internal.failCauseSync;
  * //   ...stack trace...
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const die = internal.die;
@@ -1116,7 +1116,7 @@ export {
  *
  * @see {@link sync} if the effectful computation is synchronous and does not
  * throw errors.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 try_ as try };
@@ -1137,7 +1137,7 @@ try_ as try };
  * Effect.runPromise(program)
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export const yieldNow = internal.yieldNow;
@@ -1158,7 +1158,7 @@ export const yieldNow = internal.yieldNow;
  * Effect.runPromise(program)
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 export const yieldNowWith = internal.yieldNowWith;
@@ -1178,7 +1178,7 @@ export const yieldNowWith = internal.yieldNowWith;
  * // Output: Fiber ID: 1
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 export const withFiber = core.withFiber;
@@ -2729,7 +2729,7 @@ export const tapDefect = internal.tapDefect;
  * // Ready
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export const eventually = internal.eventually;
@@ -5445,7 +5445,7 @@ export const abortSignal = internal.abortSignal;
  * })
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export const forever = internal.forever;
@@ -5522,7 +5522,7 @@ export const forever = internal.forever;
  * @see {@link retry} for failure-based repetition
  * @see {@link repeatOrElse} for fallback handling when repetition fails
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export const repeat = internalSchedule.repeat;
@@ -5565,7 +5565,7 @@ export const repeat = internalSchedule.repeat;
  * )
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export const repeatOrElse = internalSchedule.repeatOrElse;
@@ -5655,7 +5655,7 @@ export const replicateEffect = internal.replicateEffect;
  * @see {@link scheduleFrom} for a variant that allows the schedule's decision
  * to depend on the result of this effect.
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export const schedule = /*#__PURE__*/dual(2, (self, schedule) => scheduleFrom(self, undefined, schedule));
@@ -5693,7 +5693,7 @@ export const schedule = /*#__PURE__*/dual(2, (self, schedule) => scheduleFrom(se
  * // Returns the schedule count
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export const scheduleFrom = internalSchedule.scheduleFrom;
@@ -6461,7 +6461,7 @@ export const fiberId = internal.fiberId;
  * }, 500)
  * ```
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export const runFork = internal.runFork;
@@ -6492,7 +6492,7 @@ export const runFork = internal.runFork;
  * const fiber = Effect.runForkWith(services)(program)
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export const runForkWith = internal.runForkWith;
@@ -6536,7 +6536,7 @@ export const runForkWith = internal.runForkWith;
  * interrupt()
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export const runCallbackWith = internal.runCallbackWith;
@@ -6577,7 +6577,7 @@ export const runCallbackWith = internal.runCallbackWith;
  * // interrupt() to cancel the fiber if needed
  * ```
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export const runCallback = internal.runCallback;
@@ -6614,7 +6614,7 @@ export const runCallback = internal.runCallback;
  * ```
  *
  * @see {@link runPromiseExit} for a version that returns an `Exit` type instead of rejecting.
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export const runPromise = internal.runPromise;
@@ -6644,7 +6644,7 @@ export const runPromise = internal.runPromise;
  * Effect.runPromiseWith(context)(program).then(console.log)
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export const runPromiseWith = internal.runPromiseWith;
@@ -6694,7 +6694,7 @@ export const runPromiseWith = internal.runPromiseWith;
  *
  * @see {@link runPromise} for a version that rejects on failure.
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export const runPromiseExit = internal.runPromiseExit;
@@ -6728,7 +6728,7 @@ export const runPromiseExit = internal.runPromiseExit;
  * })
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export const runPromiseExitWith = internal.runPromiseExitWith;
@@ -6789,7 +6789,7 @@ export const runPromiseExitWith = internal.runPromiseExitWith;
  *
  * @see {@link runSyncExit} for a version that returns an `Exit` type instead of
  * throwing an error.
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export const runSync = internal.runSync;
@@ -6820,7 +6820,7 @@ export const runSync = internal.runSync;
  * console.log(result) // 5
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export const runSyncWith = internal.runSyncWith;
@@ -6894,7 +6894,7 @@ export const runSyncWith = internal.runSyncWith;
  *
  * @see {@link runSync} for a version that throws on failure.
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export const runSyncExit = internal.runSyncExit;
@@ -6934,7 +6934,7 @@ export const runSyncExit = internal.runSyncExit;
  * // Success: 42
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export const runSyncExitWith = internal.runSyncExitWith;

package/dist/Equal.d.ts

@@ -347,7 +347,7 @@ export declare const asEquivalence: <A>() => Equivalence<A>;
  * @see {@link byReferenceUnsafe} — same effect without a proxy (mutates the
  *   original)
  * @see {@link equals} — the comparison function affected by this opt-out
- * @category utility
+ * @category equality
  * @since 4.0.0
  */
 export declare const byReference: <T extends object>(obj: T) => T;
@@ -390,7 +390,7 @@ export declare const byReference: <T extends object>(obj: T) => T;
  *
  * @see {@link byReference} — safer alternative that creates a proxy
  * @see {@link equals} — the comparison function affected by this opt-out
- * @category utility
+ * @category unsafe
  * @since 4.0.0
  */
 export declare const byReferenceUnsafe: <T extends object>(obj: T) => T;

package/dist/Equal.js

@@ -333,7 +333,7 @@ export const asEquivalence = () => equals;
  * @see {@link byReferenceUnsafe} — same effect without a proxy (mutates the
  *   original)
  * @see {@link equals} — the comparison function affected by this opt-out
- * @category utility
+ * @category equality
  * @since 4.0.0
  */
 export const byReference = obj => byReferenceUnsafe(new Proxy(obj, {}));
@@ -376,7 +376,7 @@ export const byReference = obj => byReferenceUnsafe(new Proxy(obj, {}));
  *
  * @see {@link byReference} — safer alternative that creates a proxy
  * @see {@link equals} — the comparison function affected by this opt-out
- * @category utility
+ * @category unsafe
  * @since 4.0.0
  */
 export const byReferenceUnsafe = obj => {

package/dist/Equivalence.d.ts

@@ -962,7 +962,7 @@ export declare function Record<A>(value: Equivalence<A>): Equivalence<Record<Pro
  * @see {@link combine} Combine two equivalences
  * @see {@link combineAll} Combine multiple equivalences
  * @see {@link Reducer} Reducer type for collection operations
- * @category utils
+ * @category constructors
  * @since 4.0.0
  */
 export declare function makeReducer<A>(): Reducer.Reducer<Equivalence<A>>;

package/dist/Equivalence.js

@@ -746,7 +746,7 @@ export function Record(value) {
  * @see {@link combine} Combine two equivalences
  * @see {@link combineAll} Combine multiple equivalences
  * @see {@link Reducer} Reducer type for collection operations
- * @category utils
+ * @category constructors
  * @since 4.0.0
  */
 export function makeReducer() {

package/dist/ExecutionPlan.d.ts

@@ -340,7 +340,7 @@ export declare namespace make {
  *
  * @see {@link make} for building a plan from individual steps instead of combining existing plans
  *
- * @category Combining
+ * @category combining
  * @since 3.16.0
  */
 export declare const merge: <const Plans extends NonEmptyReadonlyArray<ExecutionPlan<any>>>(...plans: Plans) => ExecutionPlan<{
@@ -357,7 +357,7 @@ export declare const merge: <const Plans extends NonEmptyReadonlyArray<Execution
  * `attempt` is the current 1-based attempt number, and `stepIndex` is the
  * 0-based index of the plan step currently being evaluated.
  *
- * @category Metadata
+ * @category metadata
  * @since 4.0.0
  */
 export interface Metadata {

package/dist/ExecutionPlan.js

@@ -126,7 +126,7 @@ const makeProto = steps => {
  *
  * @see {@link make} for building a plan from individual steps instead of combining existing plans
  *
- * @category Combining
+ * @category combining
  * @since 3.16.0
  */
 export const merge = (...plans) => makeProto(plans.flatMap(plan => plan.steps));

package/dist/FileSystem.d.ts

@@ -620,7 +620,7 @@ export type OpenFlag = "r" | "r+" | "w" | "wx" | "w+" | "wx+" | "a" | "ax" | "a+
  * )
  * ```
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const FileSystem: Context.Service<FileSystem, FileSystem>;
@@ -764,7 +764,7 @@ export declare const FileTypeId = "~effect/platform/FileSystem/File";
  * @see {@link File} for the file-handle interface narrowed by this guard
  * @see {@link FileTypeId} for the runtime marker checked by this guard
  *
- * @category File
+ * @category file
  * @since 4.0.0
  */
 export declare const isFile: (u: unknown) => u is File;
@@ -809,7 +809,7 @@ export declare const isFile: (u: unknown) => u is File;
  * })
  * ```
  *
- * @category File
+ * @category file
  * @since 4.0.0
  */
 export interface File {
@@ -839,7 +839,7 @@ export declare namespace File {
      * File descriptors are numeric handles used by the operating system
      * to identify open files. The branded type ensures type safety.
      *
-     * @category File
+     * @category file
      * @since 4.0.0
      */
     type Descriptor = Brand.Branded<number, "FileDescriptor">;
@@ -851,7 +851,7 @@ export declare namespace File {
      * Represents the different types of entries that can exist in a file system,
      * from regular files to special device files and symbolic links.
      *
-     * @category File
+     * @category file
      * @since 4.0.0
      */
     type Type = "File" | "Directory" | "SymbolicLink" | "BlockDevice" | "CharacterDevice" | "FIFO" | "Socket" | "Unknown";
@@ -897,7 +897,7 @@ export declare namespace File {
      * })
      * ```
      *
-     * @category File
+     * @category file
      * @since 4.0.0
      */
     interface Info {

package/dist/FileSystem.js

@@ -320,7 +320,7 @@ export const PiB = n => Size(BigInt(n) * bigintPiB);
  * )
  * ```
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const FileSystem = /*#__PURE__*/Context.Service("effect/platform/FileSystem");
@@ -611,7 +611,7 @@ export const FileTypeId = "~effect/platform/FileSystem/File";
  * @see {@link File} for the file-handle interface narrowed by this guard
  * @see {@link FileTypeId} for the runtime marker checked by this guard
  *
- * @category File
+ * @category file
  * @since 4.0.0
  */
 export const isFile = u => hasProperty(u, FileTypeId);

package/dist/Function.d.ts

@@ -377,7 +377,7 @@ export declare const identity: <A>(a: A) => A;
  *
  * @see {@link cast} for changing only the static TypeScript type
  *
- * @category type utils
+ * @category utility types
  * @since 2.0.0
  */
 export declare const satisfies: <A>() => <B extends A>(b: B) => B;
@@ -396,7 +396,7 @@ export declare const satisfies: <A>() => <B extends A>(b: B) => B;
  *
  * @see {@link satisfies} for checking assignability without changing the resulting type
  *
- * @category type utils
+ * @category utility types
  * @since 4.0.0
  */
 export declare const cast: <A, B>(a: A) => B;
@@ -655,7 +655,7 @@ export declare const compose: {
  * }
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 2.0.0
  */
 export declare const absurd: <A>(_: never) => A;
@@ -901,7 +901,7 @@ export declare function flow<A extends ReadonlyArray<unknown>, B = never, C = ne
  * console.log(typeof buildUser) // "function"
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 2.0.0
  */
 export declare const hole: <T>() => T;
@@ -948,7 +948,7 @@ export declare const SK: <A, B>(_: A, b: B) => B;
  * mutated after its first call, later calls still return the cached result for
  * that reference.
  *
- * @category utils
+ * @category caching
  * @since 4.0.0
  */
 export declare function memoize<A extends object, O>(f: (a: A) => O): (ast: A) => O;

package/dist/Function.js

@@ -176,7 +176,7 @@ export const identity = a => a;
  *
  * @see {@link cast} for changing only the static TypeScript type
  *
- * @category type utils
+ * @category utility types
  * @since 2.0.0
  */
 export const satisfies = () => b => b;
@@ -195,7 +195,7 @@ export const satisfies = () => b => b;
  *
  * @see {@link satisfies} for checking assignability without changing the resulting type
  *
- * @category type utils
+ * @category utility types
  * @since 4.0.0
  */
 export const cast = identity;
@@ -399,7 +399,7 @@ export const compose = /*#__PURE__*/dual(2, (ab, bc) => a => bc(ab(a)));
  * }
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 2.0.0
  */
 export const absurd = _ => {
@@ -521,7 +521,7 @@ export function flow(ab, bc, cd, de, ef, fg, gh, hi, ij) {
  * console.log(typeof buildUser) // "function"
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 2.0.0
  */
 export const hole = /*#__PURE__*/cast(absurd);
@@ -568,7 +568,7 @@ export const SK = (_, b) => b;
  * mutated after its first call, later calls still return the cached result for
  * that reference.
  *
- * @category utils
+ * @category caching
  * @since 4.0.0
  */
 export function memoize(f) {

package/dist/Graph.d.ts

@@ -1739,7 +1739,7 @@ export declare const neighborsDirected: {
  * }
  * ```
  *
- * @category models
+ * @category options
  * @since 3.18.0
  */
 export interface GraphVizOptions<N, E> {
@@ -1788,7 +1788,7 @@ export interface GraphVizOptions<N, E> {
  * // }
  * ```
  *
- * @category utils
+ * @category converting
  * @since 3.18.0
  */
 export declare const toGraphViz: {
@@ -1821,7 +1821,7 @@ export declare const toGraphViz: {
      * // }
      * ```
      *
-     * @category utils
+     * @category converting
      * @since 3.18.0
      */
     <N, E>(options?: GraphVizOptions<N, E>): <T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => string;
@@ -1854,7 +1854,7 @@ export declare const toGraphViz: {
      * // }
      * ```
      *
-     * @category utils
+     * @category converting
      * @since 3.18.0
      */
     <N, E, T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>, options?: GraphVizOptions<N, E>): string;
@@ -2003,7 +2003,7 @@ export type MermaidDiagramType = "flowchart" | "graph";
  * }
  * ```
  *
- * @category models
+ * @category options
  * @since 3.18.0
  */
 export interface MermaidOptions<N, E> {
@@ -2210,7 +2210,7 @@ export interface MermaidOptions<N, E> {
  * //   0 -->|"builds with"| 3
  * ```
  *
- * @category utils
+ * @category converting
  * @since 3.18.0
  */
 export declare const toMermaid: {
@@ -2390,7 +2390,7 @@ export declare const toMermaid: {
      * //   0 -->|"builds with"| 3
      * ```
      *
-     * @category utils
+     * @category converting
      * @since 3.18.0
      */
     <N, E>(options?: MermaidOptions<N, E>): <T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => string;
@@ -2570,7 +2570,7 @@ export declare const toMermaid: {
      * //   0 -->|"builds with"| 3
      * ```
      *
-     * @category utils
+     * @category converting
      * @since 3.18.0
      */
     <N, E, T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>, options?: MermaidOptions<N, E>): string;
@@ -3523,7 +3523,7 @@ export type EdgeWalker<E> = Walker<EdgeIndex, Edge<E>>;
  * console.log(indices) // [0, 1]
  * ```
  *
- * @category utils
+ * @category iterators
  * @since 3.18.0
  */
 export declare const indices: <T, N>(walker: Walker<T, N>) => Iterable<T>;
@@ -3546,7 +3546,7 @@ export declare const indices: <T, N>(walker: Walker<T, N>) => Iterable<T>;
  * console.log(values) // ["A", "B"]
  * ```
  *
- * @category utils
+ * @category iterators
  * @since 3.18.0
  */
 export declare const values: <T, N>(walker: Walker<T, N>) => Iterable<N>;
@@ -3569,7 +3569,7 @@ export declare const values: <T, N>(walker: Walker<T, N>) => Iterable<N>;
  * console.log(entries) // [[0, "A"], [1, "B"]]
  * ```
  *
- * @category utils
+ * @category iterators
  * @since 3.18.0
  */
 export declare const entries: <T, N>(walker: Walker<T, N>) => Iterable<[T, N]>;