effect 4.0.0-beta.67 → 4.0.0-beta.69

package/dist/unstable/process/ChildProcess.d.ts

@@ -11,14 +11,14 @@ import { type ChildProcessHandle, ChildProcessSpawner } from "./ChildProcessSpaw
  * Commands are built using `make` and can be combined using `pipeTo`.
  * They are executed using `exec` or `spawn`.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Command = StandardCommand | PipedCommand;
 /**
  * A standard command with pre-parsed command and arguments.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StandardCommand extends Effect.Effect<ChildProcessHandle, PlatformError.PlatformError, ChildProcessSpawner | Scope.Scope> {
@@ -31,7 +31,7 @@ export interface StandardCommand extends Effect.Effect<ChildProcessHandle, Platf
  * A pipeline of commands where the output of one is piped to the input of the
  * next.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface PipedCommand extends Effect.Effect<ChildProcessHandle, PlatformError.PlatformError, ChildProcessSpawner | Scope.Scope> {
@@ -48,7 +48,7 @@ export interface PipedCommand extends Effect.Effect<ChildProcessHandle, Platform
  * - `"all"`: Pipe both stdout and stderr interleaved
  * - `` `fd${number}` ``: Pipe from a custom file descriptor (e.g., `"fd3"`)
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type PipeFromOption = "stdout" | "stderr" | "all" | `fd${number}`;
@@ -58,7 +58,7 @@ export type PipeFromOption = "stdout" | "stderr" | "all" | `fd${number}`;
  * - `"stdin"`: Pipe to stdin of the destination (default)
  * - `` `fd${number}` ``: Pipe to a custom file descriptor (e.g., `"fd3"`)
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type PipeToOption = "stdin" | `fd${number}`;
@@ -76,7 +76,7 @@ export type PipeToOption = "stdin" | `fd${number}`;
  * )
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface PipeOptions {
@@ -100,35 +100,35 @@ export interface PipeOptions {
 /**
  * Input type for child process stdin.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type CommandInput = "pipe" | "inherit" | "ignore" | "overlapped" | Stream.Stream<Uint8Array, PlatformError.PlatformError>;
 /**
  * Output type for child process stdout/stderr.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type CommandOutput = "pipe" | "inherit" | "ignore" | "overlapped" | Sink.Sink<Uint8Array, Uint8Array, never, PlatformError.PlatformError>;
 /**
  * A signal that can be sent to a child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Signal = "SIGABRT" | "SIGALRM" | "SIGBUS" | "SIGCHLD" | "SIGCONT" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINT" | "SIGIO" | "SIGIOT" | "SIGKILL" | "SIGPIPE" | "SIGPOLL" | "SIGPROF" | "SIGPWR" | "SIGQUIT" | "SIGSEGV" | "SIGSTKFLT" | "SIGSTOP" | "SIGSYS" | "SIGTERM" | "SIGTRAP" | "SIGTSTP" | "SIGTTIN" | "SIGTTOU" | "SIGUNUSED" | "SIGURG" | "SIGUSR1" | "SIGUSR2" | "SIGVTALRM" | "SIGWINCH" | "SIGXCPU" | "SIGXFSZ" | "SIGBREAK" | "SIGLOST" | "SIGINFO";
 /**
  * The encoding format to use for binary data.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Encoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex";
 /**
  * Options that can be used to control how a child process is terminated.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface KillOptions {
@@ -151,7 +151,7 @@ export interface KillOptions {
 /**
  * Configuration for the child process standard input stream.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StdinConfig {
@@ -184,7 +184,7 @@ export interface StdinConfig {
 /**
  * Configuration for the child process standard output stream.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StdoutConfig {
@@ -204,7 +204,7 @@ export interface StdoutConfig {
 /**
  * Configuration for the child process standard error stream.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StderrConfig {
@@ -224,7 +224,7 @@ export interface StderrConfig {
 /**
  * Configuration for additional file descriptors to expose to the child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type AdditionalFdConfig = {
@@ -255,7 +255,7 @@ export type AdditionalFdConfig = {
 /**
  * Options for command execution.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface CommandOptions extends KillOptions {
@@ -349,35 +349,35 @@ export interface CommandOptions extends KillOptions {
 /**
  * Valid template expression item types.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type TemplateExpressionItem = string | number | boolean;
 /**
  * Template expression type for interpolated values.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type TemplateExpression = TemplateExpressionItem | ReadonlyArray<TemplateExpressionItem>;
 /**
  * Check if a value is a `Command`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isCommand: (u: unknown) => u is Command;
 /**
  * Check if a command is a `StandardCommand`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isStandardCommand: (command: Command) => command is StandardCommand;
 /**
  * Check if a command is a `PipedCommand`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isPipedCommand: (command: Command) => command is PipedCommand;
@@ -407,7 +407,7 @@ export declare const isPipedCommand: (command: Command) => command is PipedComma
  * const cmd3 = ChildProcess.make("git", ["status"])
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const make: {
@@ -437,7 +437,7 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     (command: string, options?: CommandOptions): StandardCommand;
@@ -467,7 +467,7 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     (command: string, args: ReadonlyArray<string>, options?: CommandOptions): StandardCommand;
@@ -497,7 +497,7 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     (options: CommandOptions): (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>) => StandardCommand;
@@ -527,7 +527,7 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>): StandardCommand;
@@ -559,7 +559,7 @@ export declare const make: {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const pipeTo: {
@@ -590,7 +590,7 @@ export declare const pipeTo: {
      * )
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (that: Command, options?: PipeOptions): (self: Command) => PipedCommand;
@@ -621,7 +621,7 @@ export declare const pipeTo: {
      * )
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (self: Command, that: Command, options?: PipeOptions): PipedCommand;
@@ -645,7 +645,7 @@ export declare const pipeTo: {
  * // now prefixed will execute `time echo "foo"`
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const prefix: {
@@ -668,7 +668,7 @@ export declare const prefix: {
      * // now prefixed will execute `time echo "foo"`
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (command: string, args?: ReadonlyArray<string>): (self: Command) => Command;
@@ -691,7 +691,7 @@ export declare const prefix: {
      * // now prefixed will execute `time echo "foo"`
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>): (self: Command) => Command;
@@ -714,7 +714,7 @@ export declare const prefix: {
      * // now prefixed will execute `time echo "foo"`
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (self: Command, command: string, args?: ReadonlyArray<string>): Command;
@@ -734,7 +734,7 @@ export declare const prefix: {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const setCwd: {
@@ -753,7 +753,7 @@ export declare const setCwd: {
      * )
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (cwd: string): (self: Command) => Command;
@@ -772,7 +772,7 @@ export declare const setCwd: {
      * )
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (self: Command, cwd: string): Command;
@@ -793,7 +793,7 @@ export declare const setCwd: {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const setEnv: {
@@ -813,7 +813,7 @@ export declare const setEnv: {
      * )
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (env: Record<string, string>): (self: Command) => Command;
@@ -833,7 +833,7 @@ export declare const setEnv: {
      * )
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     (self: Command, env: Record<string, string>): Command;
@@ -842,14 +842,14 @@ export declare const setEnv: {
  * Parse an fd name like "fd3" to its numeric index.
  * Returns undefined if the name is invalid.
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export declare const parseFdName: (name: string) => number | undefined;
 /**
  * Create an fd name from its numeric index.
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export declare const fdName: (fd: number) => string;

package/dist/unstable/process/ChildProcess.js

@@ -7,8 +7,8 @@
  * **Example** (Spawning and piping commands)
  *
  * ```ts
- * import { NodeServices } from "@effect/platform-node"
  * import { Effect, Stream } from "effect"
+ * import { NodeServices } from "@effect/platform-node"
  * import { ChildProcess } from "effect/unstable/process"
  *
  * // Build a command
@@ -62,21 +62,21 @@ const Proto = {
 /**
  * Check if a value is a `Command`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isCommand = u => Predicate.hasProperty(u, TypeId);
 /**
  * Check if a command is a `StandardCommand`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isStandardCommand = command => command._tag === "StandardCommand";
 /**
  * Check if a command is a `PipedCommand`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isPipedCommand = command => command._tag === "PipedCommand";
@@ -118,7 +118,7 @@ const makePipedCommand = (left, right, options = {}) => Object.assign(Object.cre
  * const cmd3 = ChildProcess.make("git", ["status"])
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = function make(...args) {
@@ -172,7 +172,7 @@ export const make = function make(...args) {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const pipeTo = /*#__PURE__*/dual(args => isCommand(args[0]) && isCommand(args[1]), (self, that, options) => makePipedCommand(self, that, options ?? {}));
@@ -195,7 +195,7 @@ export const pipeTo = /*#__PURE__*/dual(args => isCommand(args[0]) && isCommand(
  * // now prefixed will execute `time echo "foo"`
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const prefix = function prefix(...args) {
@@ -249,7 +249,7 @@ const applyPrefix = (self, prefixSpec) => {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const setCwd = /*#__PURE__*/dual(2, (self, cwd) => {
@@ -283,7 +283,7 @@ export const setCwd = /*#__PURE__*/dual(2, (self, cwd) => {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const setEnv = /*#__PURE__*/dual(2, (self, env) => {
@@ -313,7 +313,7 @@ const isTemplateString = u => Array.isArray(u) && "raw" in u && Array.isArray(u.
  * Parse an fd name like "fd3" to its numeric index.
  * Returns undefined if the name is invalid.
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export const parseFdName = name => {
@@ -325,7 +325,7 @@ export const parseFdName = name => {
 /**
  * Create an fd name from its numeric index.
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export const fdName = fd => `fd${fd}`;

package/dist/unstable/process/ChildProcessSpawner.d.ts

@@ -17,14 +17,14 @@ import type { Command, KillOptions } from "./ChildProcess.ts";
 /**
  * Branded number representing the exit code reported by a child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type ExitCode = Brand.Branded<number, "ExitCode">;
 /**
  * Brand constructor for child process `ExitCode` values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const ExitCode: Brand.Constructor<ExitCode>;
@@ -32,14 +32,14 @@ export declare const ExitCode: Brand.Constructor<ExitCode>;
  * Branded number representing the operating system process identifier of a
  * child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type ProcessId = Brand.Branded<number, "ProcessId">;
 /**
  * Brand constructor for child process `ProcessId` values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const ProcessId: Brand.Constructor<ProcessId>;
@@ -51,7 +51,7 @@ export declare const ProcessId: Brand.Constructor<ProcessId>;
  * restore the default behavior where the child process keeps the parent
  * process alive.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Reref = Effect.Effect<void, PlatformError.PlatformError>;
@@ -59,7 +59,7 @@ declare const HandleTypeId = "~effect/ChildProcessSpawner/ChildProcessHandle";
 /**
  * A handle to a running child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ChildProcessHandle {
@@ -139,8 +139,8 @@ export interface ChildProcessHandle {
      * **Example** (Temporarily unreferencing a child process)
      *
      * ```ts
-     * import { NodeServices } from "@effect/platform-node"
      * import { Effect } from "effect"
+     * import { NodeServices } from "@effect/platform-node"
      * import { ChildProcess } from "effect/unstable/process"
      *
      * const program = Effect.gen(function*() {
@@ -159,7 +159,7 @@ export interface ChildProcessHandle {
 /**
  * Constructs a new `ChildProcessHandle`.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const makeHandle: (params: Omit<ChildProcessHandle, typeof HandleTypeId>) => ChildProcessHandle;
@@ -167,7 +167,7 @@ export declare const makeHandle: (params: Omit<ChildProcessHandle, typeof Handle
  * Creates a `ChildProcessSpawner` service from a `spawn` function, deriving
  * helpers for exit codes and output collection from that implementation.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export declare const make: (spawn: ChildProcessSpawner["Service"]["spawn"]) => ChildProcessSpawner["Service"];
@@ -210,7 +210,7 @@ declare const ChildProcessSpawner_base: Context.ServiceClass<ChildProcessSpawner
 /**
  * Service tag for child process spawning.
  *
- * @category Service
+ * @category services
  * @since 4.0.0
  */
 export declare class ChildProcessSpawner extends ChildProcessSpawner_base {

package/dist/unstable/process/ChildProcessSpawner.js

@@ -14,14 +14,14 @@ import * as Stream from "../../Stream.js";
 /**
  * Brand constructor for child process `ExitCode` values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const ExitCode = /*#__PURE__*/Brand.nominal();
 /**
  * Brand constructor for child process `ProcessId` values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const ProcessId = /*#__PURE__*/Brand.nominal();
@@ -39,7 +39,7 @@ const HandleProto = {
 /**
  * Constructs a new `ChildProcessHandle`.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeHandle = params => Object.assign(Object.create(HandleProto), params);
@@ -47,7 +47,7 @@ export const makeHandle = params => Object.assign(Object.create(HandleProto), pa
  * Creates a `ChildProcessSpawner` service from a `spawn` function, deriving
  * helpers for exit codes and output collection from that implementation.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export const make = spawn => {
@@ -65,7 +65,7 @@ export const make = spawn => {
 /**
  * Service tag for child process spawning.
  *
- * @category Service
+ * @category services
  * @since 4.0.0
  */
 export class ChildProcessSpawner extends /*#__PURE__*/Context.Service()("effect/process/ChildProcessSpawner") {}

package/dist/unstable/process/index.d.ts

@@ -10,8 +10,8 @@
  * **Example** (Spawning and piping commands)
  *
  * ```ts
- * import { NodeServices } from "@effect/platform-node"
  * import { Effect, Stream } from "effect"
+ * import { NodeServices } from "@effect/platform-node"
  * import { ChildProcess } from "effect/unstable/process"
  *
  * // Build a command

package/dist/unstable/process/index.js

@@ -11,8 +11,8 @@
  * **Example** (Spawning and piping commands)
  *
  * ```ts
- * import { NodeServices } from "@effect/platform-node"
  * import { Effect, Stream } from "effect"
+ * import { NodeServices } from "@effect/platform-node"
  * import { ChildProcess } from "effect/unstable/process"
  *
  * // Build a command

package/dist/unstable/reactivity/AsyncResult.d.ts

@@ -32,14 +32,14 @@ import type * as Types from "../../Types.ts";
 /**
  * Type-level identifier used to recognize `AsyncResult` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~effect/reactivity/AsyncResult";
 /**
  * Runtime identifier attached to `AsyncResult` values and used by `isAsyncResult`.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
@@ -53,14 +53,13 @@ export type AsyncResult<A, E = never> = Initial<A, E> | Success<A, E> | Failure<
 /**
  * Returns `true` when a value is an `AsyncResult`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isAsyncResult: (u: unknown) => u is AsyncResult<unknown, unknown>;
 /**
  * Namespace containing type-level helpers and the shared prototype shape for `AsyncResult` values.
  *
- * @category models
  * @since 4.0.0
  */
 export declare namespace AsyncResult {
@@ -80,12 +79,14 @@ export declare namespace AsyncResult {
     /**
      * Extracts the success value type from an `AsyncResult`.
      *
+     * @category utility types
      * @since 4.0.0
      */
     type Success<R> = R extends AsyncResult<infer A, infer _> ? A : never;
     /**
      * Extracts the failure error type from an `AsyncResult`.
      *
+     * @category utility types
      * @since 4.0.0
      */
     type Failure<R> = R extends AsyncResult<infer _, infer E> ? E : never;
@@ -93,6 +94,7 @@ export declare namespace AsyncResult {
 /**
  * Rebuilds an `AsyncResult` with new success and failure types while preserving the variant of another result.
  *
+ * @category utility types
  * @since 4.0.0
  */
 export type With<R extends AsyncResult<any, any>, A, E> = R extends Initial<infer _A, infer _E> ? Initial<A, E> : R extends Success<infer _A, infer _E> ? Success<A, E> : R extends Failure<infer _A, infer _E> ? Failure<A, E> : never;
@@ -531,7 +533,7 @@ export type Builder<Out, A, E, I, F> = Pipeable & {
 /**
  * Schema interface for `AsyncResult` values, retaining the schemas used for success values and failure errors.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export interface Schema<Success extends Schema_.Top, Error extends Schema_.Top> extends Schema_.declareConstructor<AsyncResult<Success["Type"], Error["Type"]>, AsyncResult<Success["Encoded"], Error["Encoded"]>, readonly [Success, Schema_.Cause<Error, Schema_.Defect>]> {
@@ -541,7 +543,7 @@ export interface Schema<Success extends Schema_.Top, Error extends Schema_.Top>
 /**
  * Creates a schema for `AsyncResult` values using optional schemas for success values and failure errors.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export declare const Schema: <A extends Schema_.Top = Schema_.Never, E extends Schema_.Top = Schema_.Never>(options: {