effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/unstable/process/ChildProcess.ts

@@ -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
@@ -61,7 +61,7 @@ const TypeId = "~effect/unstable/process/ChildProcess"
  * 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 =
@@ -71,7 +71,7 @@ export type Command =
 /**
  * A standard command with pre-parsed command and arguments.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StandardCommand extends
@@ -91,7 +91,7 @@ export interface StandardCommand extends
  * 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
@@ -115,7 +115,7 @@ export interface PipedCommand extends
  * - `"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}`
@@ -126,7 +126,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}`
@@ -145,7 +145,7 @@ export type PipeToOption = "stdin" | `fd${number}`
  * )
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface PipeOptions {
@@ -171,7 +171,7 @@ export interface PipeOptions {
 /**
  * Input type for child process stdin.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type CommandInput =
@@ -184,7 +184,7 @@ export type CommandInput =
 /**
  * Output type for child process stdout/stderr.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type CommandOutput =
@@ -197,7 +197,7 @@ export type CommandOutput =
 /**
  * A signal that can be sent to a child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Signal =
@@ -242,7 +242,7 @@ export type Signal =
 /**
  * The encoding format to use for binary data.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Encoding =
@@ -262,7 +262,7 @@ export type Encoding =
 /**
  * Options that can be used to control how a child process is terminated.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface KillOptions {
@@ -286,7 +286,7 @@ export interface KillOptions {
 /**
  * Configuration for the child process standard input stream.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StdinConfig {
@@ -320,7 +320,7 @@ export interface StdinConfig {
 /**
  * Configuration for the child process standard output stream.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StdoutConfig {
@@ -341,7 +341,7 @@ export interface StdoutConfig {
 /**
  * Configuration for the child process standard error stream.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface StderrConfig {
@@ -362,7 +362,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 =
@@ -396,7 +396,7 @@ export type AdditionalFdConfig =
 /**
  * Options for command execution.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface CommandOptions extends KillOptions {
@@ -491,7 +491,7 @@ export interface CommandOptions extends KillOptions {
 /**
  * Valid template expression item types.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type TemplateExpressionItem = string | number | boolean
@@ -499,7 +499,7 @@ 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>
@@ -521,7 +521,7 @@ const Proto = {
 /**
  * Check if a value is a `Command`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isCommand = (u: unknown): u is Command => Predicate.hasProperty(u, TypeId)
@@ -529,7 +529,7 @@ export const isCommand = (u: unknown): u is Command => Predicate.hasProperty(u,
 /**
  * Check if a command is a `StandardCommand`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isStandardCommand = (command: Command): command is StandardCommand => command._tag === "StandardCommand"
@@ -537,7 +537,7 @@ export const isStandardCommand = (command: Command): command is StandardCommand
 /**
  * Check if a command is a `PipedCommand`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isPipedCommand = (command: Command): command is PipedCommand => command._tag === "PipedCommand"
@@ -592,7 +592,7 @@ const makePipedCommand = (
  * const cmd3 = ChildProcess.make("git", ["status"])
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: {
@@ -622,7 +622,7 @@ export const make: {
    * const cmd3 = ChildProcess.make("git", ["status"])
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   (command: string, options?: CommandOptions): StandardCommand
@@ -652,7 +652,7 @@ export const make: {
    * const cmd3 = ChildProcess.make("git", ["status"])
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   (command: string, args: ReadonlyArray<string>, options?: CommandOptions): StandardCommand
@@ -682,7 +682,7 @@ export const make: {
    * const cmd3 = ChildProcess.make("git", ["status"])
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   (options: CommandOptions): (
@@ -715,7 +715,7 @@ export const make: {
    * const cmd3 = ChildProcess.make("git", ["status"])
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 4.0.0
    */
   (
@@ -784,7 +784,7 @@ export const make: {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const pipeTo: {
@@ -815,7 +815,7 @@ export const pipeTo: {
    * )
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (that: Command, options?: PipeOptions): (self: Command) => PipedCommand
@@ -846,7 +846,7 @@ export const pipeTo: {
    * )
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (self: Command, that: Command, options?: PipeOptions): PipedCommand
@@ -874,7 +874,7 @@ export const pipeTo: {
  * // now prefixed will execute `time echo "foo"`
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const prefix: {
@@ -897,7 +897,7 @@ export 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
@@ -920,7 +920,7 @@ export const prefix: {
    * // now prefixed will execute `time echo "foo"`
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (
@@ -946,7 +946,7 @@ export 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
@@ -1005,7 +1005,7 @@ const applyPrefix = (self: Command, prefixSpec: PrefixSpec): Command => {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const setCwd: {
@@ -1024,7 +1024,7 @@ export const setCwd: {
    * )
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (cwd: string): (self: Command) => Command
@@ -1043,7 +1043,7 @@ export const setCwd: {
    * )
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (self: Command, cwd: string): Command
@@ -1077,7 +1077,7 @@ export const setCwd: {
  * )
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const setEnv: {
@@ -1097,7 +1097,7 @@ export const setEnv: {
    * )
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (env: Record<string, string>): (self: Command) => Command
@@ -1117,7 +1117,7 @@ export const setEnv: {
    * )
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (self: Command, env: Record<string, string>): Command
@@ -1149,7 +1149,7 @@ const isTemplateString = (u: unknown): u is TemplateStringsArray =>
  * 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: string): number | undefined => {
@@ -1162,7 +1162,7 @@ export const parseFdName = (name: string): number | undefined => {
 /**
  * Create an fd name from its numeric index.
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export const fdName = (fd: number): string => `fd${fd}`

package/src/unstable/process/ChildProcessSpawner.ts

@@ -19,7 +19,7 @@ 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">
@@ -27,7 +27,7 @@ export type ExitCode = Brand.Branded<number, "ExitCode">
 /**
  * Brand constructor for child process `ExitCode` values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const ExitCode: Brand.Constructor<ExitCode> = Brand.nominal<ExitCode>()
@@ -36,7 +36,7 @@ export const ExitCode: Brand.Constructor<ExitCode> = Brand.nominal<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">
@@ -44,7 +44,7 @@ export type ProcessId = Brand.Branded<number, "ProcessId">
 /**
  * Brand constructor for child process `ProcessId` values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const ProcessId: Brand.Constructor<ProcessId> = Brand.nominal<ProcessId>()
@@ -57,7 +57,7 @@ export const ProcessId: Brand.Constructor<ProcessId> = Brand.nominal<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>
@@ -67,7 +67,7 @@ const HandleTypeId = "~effect/ChildProcessSpawner/ChildProcessHandle"
 /**
  * A handle to a running child process.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ChildProcessHandle {
@@ -147,8 +147,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*() {
@@ -176,7 +176,7 @@ const HandleProto = {
 /**
  * Constructs a new `ChildProcessHandle`.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeHandle = (params: Omit<ChildProcessHandle, typeof HandleTypeId>): ChildProcessHandle =>
@@ -186,7 +186,7 @@ export const makeHandle = (params: Omit<ChildProcessHandle, typeof HandleTypeId>
  * 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: ChildProcessSpawner["Service"]["spawn"]): ChildProcessSpawner["Service"] => {
@@ -215,7 +215,7 @@ export const make = (spawn: ChildProcessSpawner["Service"]["spawn"]): ChildProce
 /**
  * Service tag for child process spawning.
  *
- * @category Service
+ * @category services
  * @since 4.0.0
  */
 export class ChildProcessSpawner extends Context.Service<ChildProcessSpawner, {

package/src/unstable/reactivity/AsyncResult.ts

@@ -42,7 +42,7 @@ 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"
@@ -50,7 +50,7 @@ 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 const TypeId: TypeId = "~effect/reactivity/AsyncResult"
@@ -66,7 +66,7 @@ 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 const isAsyncResult = (u: unknown): u is AsyncResult<unknown, unknown> => hasProperty(u, TypeId)
@@ -74,7 +74,6 @@ export 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 {
@@ -95,6 +94,7 @@ export declare namespace AsyncResult {
   /**
    * Extracts the success value type from an `AsyncResult`.
    *
+   * @category utility types
    * @since 4.0.0
    */
   export type Success<R> = R extends AsyncResult<infer A, infer _> ? A : never
@@ -102,6 +102,7 @@ export declare namespace AsyncResult {
   /**
    * Extracts the failure error type from an `AsyncResult`.
    *
+   * @category utility types
    * @since 4.0.0
    */
   export type Failure<R> = R extends AsyncResult<infer _, infer E> ? E : never
@@ -110,6 +111,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>
@@ -1017,7 +1019,7 @@ class BuilderImpl<Out, A, E> {
 /**
  * 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<
@@ -1037,7 +1039,7 @@ export interface Schema<
 /**
  * Creates a schema for `AsyncResult` values using optional schemas for success values and failure errors.
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export const Schema = <