effect 4.0.0-beta.66 → 4.0.0-beta.67

package/dist/unstable/persistence/Redis.js

@@ -1,4 +1,20 @@
 /**
+ * Low-level Redis integration for the persistence modules.
+ *
+ * This module defines the `Redis` service used by Redis-backed persistence,
+ * persisted queues, and rate limiter stores. It adapts an external Redis
+ * connection to Effect through `send` for raw commands and `eval` for typed
+ * Lua scripts that are loaded with `SCRIPT LOAD` and executed with `EVALSHA`.
+ *
+ * The service does not create or manage Redis connections; callers provide a
+ * command sender from their Redis client or pool. Higher-level stores layer on
+ * key prefixes and store ids, so choose stable prefixes to avoid collisions
+ * and remember that schema or primary-key changes can make previously persisted
+ * JSON values fail to decode. Finite TTLs in the persistence stores are applied
+ * with millisecond Redis expirations, while non-finite TTLs are stored without
+ * expiration. Script parameters are stringified before execution, and the
+ * script descriptor's key count controls how Redis splits `KEYS` from `ARGV`.
+ *
  * @since 4.0.0
  */
 import * as Cache from "../../Cache.js";
@@ -9,13 +25,20 @@ import { constant, identity } from "../../Function.js";
 import * as Hash from "../../Hash.js";
 import * as Schema from "../../Schema.js";
 /**
- * @since 4.0.0
+ * Service for sending Redis commands and evaluating cached Lua scripts.
+ *
  * @category Service
+ * @since 4.0.0
  */
 export class Redis extends /*#__PURE__*/Context.Service()("effect/persistence/Redis") {}
 /**
- * @since 4.0.0
+ * Creates a `Redis` service from a raw command sender.
+ *
+ * Lua scripts are loaded through `SCRIPT LOAD`, cached, and then invoked with
+ * `EVALSHA`.
+ *
  * @category Constructors
+ * @since 4.0.0
  */
 export const make = /*#__PURE__*/Effect.fnUntraced(function* (options) {
   const scriptCache = yield* Cache.make({
@@ -30,14 +53,18 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* (options) {
 });
 const ErrorTypeId = "~effect/persistence/Redis/RedisError";
 /**
- * @since 4.0.0
+ * Error raised by Redis command or script execution.
+ *
  * @category Errors
+ * @since 4.0.0
  */
 export class RedisError extends /*#__PURE__*/Schema.ErrorClass(ErrorTypeId)({
   _tag: /*#__PURE__*/Schema.tag("RedisError"),
   cause: Schema.Defect
 }) {
   /**
+   * Marks this value as a Redis persistence error for runtime guards.
+   *
    * @since 4.0.0
    */
   [ErrorTypeId] = ErrorTypeId;
@@ -59,8 +86,13 @@ const ScriptProto = {
   }
 };
 /**
- * @since 4.0.0
+ * Constructs a typed Redis Lua script descriptor.
+ *
+ * The result type defaults to `void` and can be refined with
+ * `withReturnType`.
+ *
  * @category Scripting
+ * @since 4.0.0
  */
 export const script = (f, options) => Object.assign(Object.create(ScriptProto), {
   ...options,

package/dist/unstable/persistence/Redis.js.map

@@ -1 +1 @@
-{"version":3,"file":"Redis.js","names":["Cache","Context","Effect","Equal","constant","identity","Hash","Schema","Redis","Service","make","fnUntraced","options","scriptCache","lookup","script","send","lua","capacity","Number","POSITIVE_INFINITY","eval_","params","flatMap","get","sha","numberOfKeys","toString","map","param","String","eval","ErrorTypeId","RedisError","ErrorClass","_tag","tag","cause","Defect","ScriptTypeId","ScriptProto","result","withReturnType","symbol","that","random","f","Object","assign","create"],"sources":["../../../src/unstable/persistence/Redis.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,SAASC,QAAQ,EAAEC,QAAQ,QAAQ,mBAAmB;AACtD,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC;;;;AAIA,OAAM,MAAOC,KAAM,sBAAQP,OAAO,CAACQ,OAAO,EAStC,CAAC,0BAA0B,CAAC;AAEhC;;;;AAIA,OAAO,MAAMC,IAAI,gBAAGR,MAAM,CAACS,UAAU,CAAC,WACpCC,OAEC;EAED,MAAMC,WAAW,GAAG,OAAOb,KAAK,CAACU,IAAI,CAAC;IACpCI,MAAM,EAAGC,MAAmB,IAAKH,OAAO,CAACI,IAAI,CAAS,QAAQ,EAAE,MAAM,EAAED,MAAM,CAACE,GAAG,CAAC;IACnFC,QAAQ,EAAEC,MAAM,CAACC;GAClB,CAAC;EAEF,MAAMC,KAAK,GAMTN,MAAsB,IAExB,CAAC,GAAGO,MAAwB,KAC1BpB,MAAM,CAACqB,OAAO,CAACvB,KAAK,CAACwB,GAAG,CAACX,WAAW,EAAEE,MAAM,CAAC,EAAGU,GAAG,IACjDb,OAAO,CAACI,IAAI,CACV,SAAS,EACTS,GAAG,EACHV,MAAM,CAACW,YAAY,CAAC,GAAGJ,MAAM,CAAC,CAACK,QAAQ,EAAE,EACzC,GAAGZ,MAAM,CAACO,MAAM,CAAC,GAAGA,MAAM,CAAC,CAACM,GAAG,CAAEC,KAAK,IAAKC,MAAM,CAACD,KAAK,CAAC,CAAC,CAC1D,CAAC;EAEN,OAAOxB,QAAQ,CAAmB;IAChCW,IAAI,EAAEJ,OAAO,CAACI,IAAI;IAClBe,IAAI,EAAEV;GACP,CAAC;AACJ,CAAC,CAAC;AAGF,MAAMW,WAAW,GAAgB,sCAAsC;AAEvE;;;;AAIA,OAAM,MAAOC,UAAW,sBAAQ1B,MAAM,CAAC2B,UAAU,CAAaF,WAAW,CAAC,CAAC;EACzEG,IAAI,eAAE5B,MAAM,CAAC6B,GAAG,CAAC,YAAY,CAAC;EAC9BC,KAAK,EAAE9B,MAAM,CAAC+B;CACf,CAAC;EACA;;;EAGS,CAACN,WAAW,IAAiBA,WAAW;;AAInD,MAAMO,YAAY,GAAiB,kCAAkC;AA6BrE,MAAMC,WAAW,GAAG;EAClB,CAACD,YAAY,GAAG;IACdjB,MAAM,EAAEjB,QAAQ;IAChBoC,MAAM,EAAEpC;GACT;EACDqC,cAAcA,CAAA;IACZ,OAAO,IAAI;EACb,CAAC;EACD,CAACvC,KAAK,CAACwC,MAAM,EAAEC,IAAa;IAC1B,OAAO,IAAI,KAAKA,IAAI;EACtB,CAAC;EACD,CAACtC,IAAI,CAACqC,MAAM,IAAC;IACX,OAAOrC,IAAI,CAACuC,MAAM,CAAC,IAAI,CAAC;EAC1B;CACD;AAED;;;;AAIA,OAAO,MAAM9B,MAAM,GAAGA,CACpB+B,CAAgD,EAChDlC,OAGC,KAKDmC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACT,WAAW,CAAC,EAAE;EACxC,GAAG5B,OAAO;EACVU,MAAM,EAAEwB,CAAC;EACTpB,YAAY,EAAE,OAAOd,OAAO,CAACc,YAAY,KAAK,QAAQ,GAAGtB,QAAQ,CAACQ,OAAO,CAACc,YAAY,CAAC,GAAGd,OAAO,CAACc;CACnG,CAAC","ignoreList":[]}
+{"version":3,"file":"Redis.js","names":["Cache","Context","Effect","Equal","constant","identity","Hash","Schema","Redis","Service","make","fnUntraced","options","scriptCache","lookup","script","send","lua","capacity","Number","POSITIVE_INFINITY","eval_","params","flatMap","get","sha","numberOfKeys","toString","map","param","String","eval","ErrorTypeId","RedisError","ErrorClass","_tag","tag","cause","Defect","ScriptTypeId","ScriptProto","result","withReturnType","symbol","that","random","f","Object","assign","create"],"sources":["../../../src/unstable/persistence/Redis.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,SAASC,QAAQ,EAAEC,QAAQ,QAAQ,mBAAmB;AACtD,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAEzC;;;;;;AAMA,OAAM,MAAOC,KAAM,sBAAQP,OAAO,CAACQ,OAAO,EAStC,CAAC,0BAA0B,CAAC;AAEhC;;;;;;;;;AASA,OAAO,MAAMC,IAAI,gBAAGR,MAAM,CAACS,UAAU,CAAC,WACpCC,OAEC;EAED,MAAMC,WAAW,GAAG,OAAOb,KAAK,CAACU,IAAI,CAAC;IACpCI,MAAM,EAAGC,MAAmB,IAAKH,OAAO,CAACI,IAAI,CAAS,QAAQ,EAAE,MAAM,EAAED,MAAM,CAACE,GAAG,CAAC;IACnFC,QAAQ,EAAEC,MAAM,CAACC;GAClB,CAAC;EAEF,MAAMC,KAAK,GAMTN,MAAsB,IAExB,CAAC,GAAGO,MAAwB,KAC1BpB,MAAM,CAACqB,OAAO,CAACvB,KAAK,CAACwB,GAAG,CAACX,WAAW,EAAEE,MAAM,CAAC,EAAGU,GAAG,IACjDb,OAAO,CAACI,IAAI,CACV,SAAS,EACTS,GAAG,EACHV,MAAM,CAACW,YAAY,CAAC,GAAGJ,MAAM,CAAC,CAACK,QAAQ,EAAE,EACzC,GAAGZ,MAAM,CAACO,MAAM,CAAC,GAAGA,MAAM,CAAC,CAACM,GAAG,CAAEC,KAAK,IAAKC,MAAM,CAACD,KAAK,CAAC,CAAC,CAC1D,CAAC;EAEN,OAAOxB,QAAQ,CAAmB;IAChCW,IAAI,EAAEJ,OAAO,CAACI,IAAI;IAClBe,IAAI,EAAEV;GACP,CAAC;AACJ,CAAC,CAAC;AAGF,MAAMW,WAAW,GAAgB,sCAAsC;AAEvE;;;;;;AAMA,OAAM,MAAOC,UAAW,sBAAQ1B,MAAM,CAAC2B,UAAU,CAAaF,WAAW,CAAC,CAAC;EACzEG,IAAI,eAAE5B,MAAM,CAAC6B,GAAG,CAAC,YAAY,CAAC;EAC9BC,KAAK,EAAE9B,MAAM,CAAC+B;CACf,CAAC;EACA;;;;;EAKS,CAACN,WAAW,IAAiBA,WAAW;;AAInD,MAAMO,YAAY,GAAiB,kCAAkC;AAkCrE,MAAMC,WAAW,GAAG;EAClB,CAACD,YAAY,GAAG;IACdjB,MAAM,EAAEjB,QAAQ;IAChBoC,MAAM,EAAEpC;GACT;EACDqC,cAAcA,CAAA;IACZ,OAAO,IAAI;EACb,CAAC;EACD,CAACvC,KAAK,CAACwC,MAAM,EAAEC,IAAa;IAC1B,OAAO,IAAI,KAAKA,IAAI;EACtB,CAAC;EACD,CAACtC,IAAI,CAACqC,MAAM,IAAC;IACX,OAAOrC,IAAI,CAACuC,MAAM,CAAC,IAAI,CAAC;EAC1B;CACD;AAED;;;;;;;;;AASA,OAAO,MAAM9B,MAAM,GAAGA,CACpB+B,CAAgD,EAChDlC,OAGC,KAKDmC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACT,WAAW,CAAC,EAAE;EACxC,GAAG5B,OAAO;EACVU,MAAM,EAAEwB,CAAC;EACTpB,YAAY,EAAE,OAAOd,OAAO,CAACc,YAAY,KAAK,QAAQ,GAAGtB,QAAQ,CAACQ,OAAO,CAACc,YAAY,CAAC,GAAGd,OAAO,CAACc;CACnG,CAAC","ignoreList":[]}

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

@@ -11,15 +11,15 @@ import { type ChildProcessHandle, ChildProcessSpawner } from "./ChildProcessSpaw
  * Commands are built using `make` and can be combined using `pipeTo`.
  * They are executed using `exec` or `spawn`.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export type Command = StandardCommand | PipedCommand;
 /**
  * A standard command with pre-parsed command and arguments.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface StandardCommand extends Effect.Effect<ChildProcessHandle, PlatformError.PlatformError, ChildProcessSpawner | Scope.Scope> {
     readonly _tag: "StandardCommand";
@@ -31,8 +31,8 @@ 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.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface PipedCommand extends Effect.Effect<ChildProcessHandle, PlatformError.PlatformError, ChildProcessSpawner | Scope.Scope> {
     readonly _tag: "PipedCommand";
@@ -48,8 +48,8 @@ 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"`)
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export type PipeFromOption = "stdout" | "stderr" | "all" | `fd${number}`;
 /**
@@ -58,14 +58,15 @@ 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"`)
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export type PipeToOption = "stdin" | `fd${number}`;
 /**
  * Options for controlling how commands are piped together.
  *
- * @example
+ * **Example** (Piping stderr between commands)
+ *
  * ```ts
  * import { ChildProcess } from "effect/unstable/process"
  *
@@ -75,8 +76,8 @@ export type PipeToOption = "stdin" | `fd${number}`;
  * )
  * ```
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface PipeOptions {
     /**
@@ -99,36 +100,36 @@ export interface PipeOptions {
 /**
  * Input type for child process stdin.
  *
- * @since 4.0.0
  * @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.
  *
- * @since 4.0.0
  * @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.
  *
- * @since 4.0.0
  * @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.
  *
- * @since 4.0.0
  * @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.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface KillOptions {
     /**
@@ -150,8 +151,8 @@ export interface KillOptions {
 /**
  * Configuration for the child process standard input stream.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface StdinConfig {
     /**
@@ -183,8 +184,8 @@ export interface StdinConfig {
 /**
  * Configuration for the child process standard output stream.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface StdoutConfig {
     /**
@@ -203,8 +204,8 @@ export interface StdoutConfig {
 /**
  * Configuration for the child process standard error stream.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface StderrConfig {
     /**
@@ -223,8 +224,8 @@ export interface StderrConfig {
 /**
  * Configuration for additional file descriptors to expose to the child process.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export type AdditionalFdConfig = {
     /**
@@ -254,8 +255,8 @@ export type AdditionalFdConfig = {
 /**
  * Options for command execution.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export interface CommandOptions extends KillOptions {
     /**
@@ -323,7 +324,8 @@ export interface CommandOptions extends KillOptions {
      * The file descriptor index is determined by the numeric suffix (i.e. `fd3`
      * has a file descriptor index of 3).
      *
-     * @example
+     * **Example** (Configuring additional file descriptors)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -347,36 +349,36 @@ export interface CommandOptions extends KillOptions {
 /**
  * Valid template expression item types.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export type TemplateExpressionItem = string | number | boolean;
 /**
  * Template expression type for interpolated values.
  *
- * @since 4.0.0
  * @category Models
+ * @since 4.0.0
  */
 export type TemplateExpression = TemplateExpressionItem | ReadonlyArray<TemplateExpressionItem>;
 /**
  * Check if a value is a `Command`.
  *
- * @since 4.0.0
  * @category Guards
+ * @since 4.0.0
  */
 export declare const isCommand: (u: unknown) => u is Command;
 /**
  * Check if a command is a `StandardCommand`.
  *
- * @since 4.0.0
  * @category Guards
+ * @since 4.0.0
  */
 export declare const isStandardCommand: (command: Command) => command is StandardCommand;
 /**
  * Check if a command is a `PipedCommand`.
  *
- * @since 4.0.0
  * @category Guards
+ * @since 4.0.0
  */
 export declare const isPipedCommand: (command: Command) => command is PipedCommand;
 /**
@@ -390,7 +392,8 @@ export declare const isPipedCommand: (command: Command) => command is PipedComma
  * Template literals are not parsed until execution time, allowing parsing
  * errors to flow through Effect's error channel.
  *
- * @example
+ * **Example** (Creating commands)
+ *
  * ```ts
  * import { ChildProcess } from "effect/unstable/process"
  *
@@ -404,8 +407,8 @@ export declare const isPipedCommand: (command: Command) => command is PipedComma
  * const cmd3 = ChildProcess.make("git", ["status"])
  * ```
  *
- * @since 4.0.0
  * @category Constructors
+ * @since 4.0.0
  */
 export declare const make: {
     /**
@@ -419,7 +422,8 @@ export declare const make: {
      * Template literals are not parsed until execution time, allowing parsing
      * errors to flow through Effect's error channel.
      *
-     * @example
+     * **Example** (Creating commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -433,8 +437,8 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @since 4.0.0
      * @category Constructors
+     * @since 4.0.0
      */
     (command: string, options?: CommandOptions): StandardCommand;
     /**
@@ -448,7 +452,8 @@ export declare const make: {
      * Template literals are not parsed until execution time, allowing parsing
      * errors to flow through Effect's error channel.
      *
-     * @example
+     * **Example** (Creating commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -462,8 +467,8 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @since 4.0.0
      * @category Constructors
+     * @since 4.0.0
      */
     (command: string, args: ReadonlyArray<string>, options?: CommandOptions): StandardCommand;
     /**
@@ -477,7 +482,8 @@ export declare const make: {
      * Template literals are not parsed until execution time, allowing parsing
      * errors to flow through Effect's error channel.
      *
-     * @example
+     * **Example** (Creating commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -491,8 +497,8 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @since 4.0.0
      * @category Constructors
+     * @since 4.0.0
      */
     (options: CommandOptions): (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>) => StandardCommand;
     /**
@@ -506,7 +512,8 @@ export declare const make: {
      * Template literals are not parsed until execution time, allowing parsing
      * errors to flow through Effect's error channel.
      *
-     * @example
+     * **Example** (Creating commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -520,8 +527,8 @@ export declare const make: {
      * const cmd3 = ChildProcess.make("git", ["status"])
      * ```
      *
-     * @since 4.0.0
      * @category Constructors
+     * @since 4.0.0
      */
     (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>): StandardCommand;
 };
@@ -531,7 +538,8 @@ export declare const make: {
  * By default, pipes `stdout` from the source to `stdin` of the destination.
  * Use the `options` parameter to customize which streams are connected.
  *
- * @example
+ * **Example** (Piping command output)
+ *
  * ```ts
  * import { ChildProcess } from "effect/unstable/process"
  *
@@ -551,8 +559,8 @@ export declare const make: {
  * )
  * ```
  *
- * @since 4.0.0
  * @category Combinators
+ * @since 4.0.0
  */
 export declare const pipeTo: {
     /**
@@ -561,7 +569,8 @@ export declare const pipeTo: {
      * By default, pipes `stdout` from the source to `stdin` of the destination.
      * Use the `options` parameter to customize which streams are connected.
      *
-     * @example
+     * **Example** (Piping command output)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -581,8 +590,8 @@ export declare const pipeTo: {
      * )
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (that: Command, options?: PipeOptions): (self: Command) => PipedCommand;
     /**
@@ -591,7 +600,8 @@ export declare const pipeTo: {
      * By default, pipes `stdout` from the source to `stdin` of the destination.
      * Use the `options` parameter to customize which streams are connected.
      *
-     * @example
+     * **Example** (Piping command output)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -611,8 +621,8 @@ export declare const pipeTo: {
      * )
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (self: Command, that: Command, options?: PipeOptions): PipedCommand;
 };
@@ -621,7 +631,8 @@ export declare const pipeTo: {
  *
  * For pipelines, only the leftmost command is prefixed.
  *
- * @example
+ * **Example** (Prefixing commands)
+ *
  * ```ts
  * import { ChildProcess } from "effect/unstable/process"
  *
@@ -634,8 +645,8 @@ export declare const pipeTo: {
  * // now prefixed will execute `time echo "foo"`
  * ```
  *
- * @since 4.0.0
  * @category Combinators
+ * @since 4.0.0
  */
 export declare const prefix: {
     /**
@@ -643,7 +654,8 @@ export declare const prefix: {
      *
      * For pipelines, only the leftmost command is prefixed.
      *
-     * @example
+     * **Example** (Prefixing commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -656,8 +668,8 @@ export declare const prefix: {
      * // now prefixed will execute `time echo "foo"`
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (command: string, args?: ReadonlyArray<string>): (self: Command) => Command;
     /**
@@ -665,7 +677,8 @@ export declare const prefix: {
      *
      * For pipelines, only the leftmost command is prefixed.
      *
-     * @example
+     * **Example** (Prefixing commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -678,8 +691,8 @@ export declare const prefix: {
      * // now prefixed will execute `time echo "foo"`
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>): (self: Command) => Command;
     /**
@@ -687,7 +700,8 @@ export declare const prefix: {
      *
      * For pipelines, only the leftmost command is prefixed.
      *
-     * @example
+     * **Example** (Prefixing commands)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -700,8 +714,8 @@ export declare const prefix: {
      * // now prefixed will execute `time echo "foo"`
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (self: Command, command: string, args?: ReadonlyArray<string>): Command;
 };
@@ -710,7 +724,8 @@ export declare const prefix: {
  *
  * For pipelines, applies to each command in the pipeline.
  *
- * @example
+ * **Example** (Setting command working directories)
+ *
  * ```ts
  * import { ChildProcess } from "effect/unstable/process"
  *
@@ -719,8 +734,8 @@ export declare const prefix: {
  * )
  * ```
  *
- * @since 4.0.0
  * @category Combinators
+ * @since 4.0.0
  */
 export declare const setCwd: {
     /**
@@ -728,7 +743,8 @@ export declare const setCwd: {
      *
      * For pipelines, applies to each command in the pipeline.
      *
-     * @example
+     * **Example** (Setting command working directories)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -737,8 +753,8 @@ export declare const setCwd: {
      * )
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (cwd: string): (self: Command) => Command;
     /**
@@ -746,7 +762,8 @@ export declare const setCwd: {
      *
      * For pipelines, applies to each command in the pipeline.
      *
-     * @example
+     * **Example** (Setting command working directories)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -755,17 +772,19 @@ export declare const setCwd: {
      * )
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (self: Command, cwd: string): Command;
 };
 /**
- * Set environment variables for a command.
+ * Adds environment variables to a command, merging them with any existing
+ * command environment and overriding duplicate keys.
  *
  * For pipelines, applies to each command in the pipeline.
  *
- * @example
+ * **Example** (Setting command environment variables)
+ *
  * ```ts
  * import { ChildProcess } from "effect/unstable/process"
  *
@@ -774,16 +793,18 @@ export declare const setCwd: {
  * )
  * ```
  *
- * @since 4.0.0
  * @category Combinators
+ * @since 4.0.0
  */
 export declare const setEnv: {
     /**
-     * Set environment variables for a command.
+     * Adds environment variables to a command, merging them with any existing
+     * command environment and overriding duplicate keys.
      *
      * For pipelines, applies to each command in the pipeline.
      *
-     * @example
+     * **Example** (Setting command environment variables)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -792,16 +813,18 @@ export declare const setEnv: {
      * )
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (env: Record<string, string>): (self: Command) => Command;
     /**
-     * Set environment variables for a command.
+     * Adds environment variables to a command, merging them with any existing
+     * command environment and overriding duplicate keys.
      *
      * For pipelines, applies to each command in the pipeline.
      *
-     * @example
+     * **Example** (Setting command environment variables)
+     *
      * ```ts
      * import { ChildProcess } from "effect/unstable/process"
      *
@@ -810,8 +833,8 @@ export declare const setEnv: {
      * )
      * ```
      *
-     * @since 4.0.0
      * @category Combinators
+     * @since 4.0.0
      */
     (self: Command, env: Record<string, string>): Command;
 };
@@ -819,15 +842,15 @@ export declare const setEnv: {
  * Parse an fd name like "fd3" to its numeric index.
  * Returns undefined if the name is invalid.
  *
- * @since 4.0.0
  * @category Utilities
+ * @since 4.0.0
  */
 export declare const parseFdName: (name: string) => number | undefined;
 /**
  * Create an fd name from its numeric index.
  *
- * @since 4.0.0
  * @category Utilities
+ * @since 4.0.0
  */
 export declare const fdName: (fd: number) => string;
 //# sourceMappingURL=ChildProcess.d.ts.map