@orkestrel/process 0.0.8 → 0.0.10

package/dist/src/core/index.d.ts

@@ -47,33 +47,33 @@ export declare function createInvalidError(subject: string, value: unknown): Pro
 export declare function createProtocolError(id: string): ProcessError;
 
 /**
- * Options for a detached fire-and-forget spawn.
+ * Configures a detached fire-and-forget spawn.
  *
  * @remarks
  * A detached child owns no stdio and is never awaited, so the contract carries only the directory it
  * starts in. Its environment comes from the command's own `environment` and `isolated`.
  */
 export declare interface DetachOptions {
-    /** The working directory. Default: the current working directory. */
+    /** Names the working directory. Default: the current working directory. */
     readonly workspace?: string;
 }
 
 /**
- * Lookup inputs for resolving a command file to an executable path.
+ * Supplies the lookup inputs for resolving a command file to an executable path.
  *
  * @remarks
  * `workspace` is searched before `PATH`, matching Windows command semantics. `environment` is the
  * child's effective environment, so the lookup reads the same `PATH` and `PATHEXT` the child will.
  */
 export declare interface ExecutableOptions {
-    /** The directory searched first. Default: the current working directory. */
+    /** Names the directory searched first. Default: the current working directory. */
     readonly workspace?: string;
-    /** The child's effective environment. Default: the parent process environment. */
+    /** Holds the child's effective environment. Default: the parent process environment. */
     readonly environment?: Readonly<Record<string, string | undefined>>;
 }
 
 /**
- * The captured bytes and terminal facts one settled {@link ExecuteResult} is built from.
+ * Represents the captured bytes and terminal facts one settled {@link ExecuteResult} is built from.
  *
  * @remarks
  * Each byte field is trimmed to `limit` on a code-point boundary when the result is built, so a
@@ -81,13 +81,15 @@ export declare interface ExecutableOptions {
  * that ended the run, when one did; its presence alone marks the run failed.
  */
 export declare interface ExecuteInput {
-    /** The diagnostic command line. */
+    /** Holds the diagnostic command line. */
     readonly command: string;
-    /** The retained standard-output bytes. */
+    /** Holds the retained standard-output bytes. */
     readonly stdout: Uint8Array;
-    /** The retained standard-error bytes. */
+    /** Holds the retained standard-error bytes. */
     readonly stderr: Uint8Array;
+    /** Holds the exit code. A spawn fault reports the host's negative errno for `execute` and `null` for `executeSync`. */
     readonly code: number | null;
+    /** Holds the terminating signal name, or `null` when the process exited on its own. */
     readonly signal: string | null;
     /** If `true`, the run's own timeout elapsed; if `false`, it did not. */
     readonly expired: boolean;
@@ -95,14 +97,14 @@ export declare interface ExecuteInput {
     readonly aborted: boolean;
     /** If `true`, a stream exceeded `limit`; if `false`, neither did. */
     readonly truncated: boolean;
-    /** The maximum retained bytes for each stream. */
+    /** Sets the maximum retained bytes for each stream. */
     readonly limit: number;
-    /** The host fault that ended the run, when one did. */
+    /** Carries the host fault that ended the run, when one did. */
     readonly cause?: unknown;
 }
 
 /**
- * Options for a one-shot run.
+ * Configures a one-shot run.
  *
  * @remarks
  * A run is a fire-and-collect function, not a lifecycle entity, so it carries no emitter. `strict`
@@ -117,26 +119,26 @@ export declare interface ExecuteInput {
  * that throws strands no process.
  */
 export declare interface ExecuteOptions {
-    /** The working directory. Default: the current working directory. */
+    /** Names the working directory. Default: the current working directory. */
     readonly workspace?: string;
-    /** Environment overrides merged over the parent environment; an `undefined` value unsets a key. */
+    /** Holds environment overrides merged over the parent environment; an `undefined` value unsets a key. */
     readonly environment?: Readonly<Record<string, string | undefined>>;
-    /** Standard-input payload written to the child, including any NUL characters. */
+    /** Holds the standard-input payload written to the child, including any NUL characters. */
     readonly input?: string;
-    /** Milliseconds before the child is terminated. `0` or omitted disables the timeout. */
+    /** Sets the milliseconds before the child is terminated. `0` or omitted disables the timeout. */
     readonly timeout?: number;
-    /** Cooperative POSIX window between `SIGTERM` and `SIGKILL` when terminating. Default: {@link PROCESS_GRACE}. */
+    /** Sets the cooperative POSIX window between `SIGTERM` and `SIGKILL` when terminating. Default: {@link PROCESS_GRACE}. */
     readonly grace?: number;
-    /** Aborting this signal terminates the run and reports `aborted`. */
+    /** Terminates the run and reports `aborted` when this signal aborts. */
     readonly signal?: AbortSignal;
-    /** If `false`, resolve with the result on failure instead of rejecting. Default: `true`. */
+    /** If `true`, reject on failure; if `false`, resolve with the result instead. Default: `true`. */
     readonly strict?: boolean;
-    /** Maximum captured bytes for stdout and for stderr, each. Default: {@link PROCESS_OUTPUT}. */
+    /** Sets the maximum captured bytes for stdout and for stderr, each. Default: {@link PROCESS_OUTPUT}. */
     readonly limit?: number;
 }
 
 /**
- * The settled outcome of a one-shot run: the buffered output and the terminal state.
+ * Represents the settled outcome of a one-shot run: the buffered output and the terminal state.
  *
  * @remarks
  * `failed` is `true` when the run timed out, was aborted, ended on a host fault, was ended by a
@@ -150,27 +152,28 @@ export declare interface ExecuteOptions {
  * the host's negative errno for `execute`. A spawn fault reports `null` for `executeSync`.
  */
 export declare interface ExecuteResult {
-    /** The command line that was run, for diagnostics. */
+    /** Holds the command line that was run, for diagnostics. */
     readonly command: string;
-    /** The captured standard output, byte-bounded by `limit`. */
+    /** Holds the captured standard output, byte-bounded by `limit`. */
     readonly stdout: string;
-    /** The captured standard error, byte-bounded by `limit`. */
+    /** Holds the captured standard error, byte-bounded by `limit`. */
     readonly stderr: string;
-    /** The exit code. A spawn fault reports the host's negative errno for `execute` and `null` for `executeSync`. */
+    /** Holds the exit code. A spawn fault reports the host's negative errno for `execute` and `null` for `executeSync`. */
     readonly code: number | null;
+    /** Holds the terminating signal name, or `null` when the process exited on its own. */
     readonly signal: string | null;
-    /** True if the run did not complete successfully. */
+    /** Reports whether the run failed to complete successfully. */
     readonly failed: boolean;
-    /** True if the run's `timeout` elapsed before completion. */
+    /** Reports whether the run's `timeout` elapsed before completion. */
     readonly expired: boolean;
-    /** True if the caller's `signal` aborted the run before completion. */
+    /** Reports whether the caller's `signal` aborted the run before completion. */
     readonly aborted: boolean;
-    /** True when either captured stream omitted output because it exceeded `limit`. */
+    /** Reports whether either captured stream omitted output because it exceeded `limit`. */
     readonly truncated: boolean;
 }
 
 /**
- * Options for a synchronous one-shot run.
+ * Configures a synchronous one-shot run.
  *
  * @remarks
  * The synchronous host offers neither a cooperative termination window nor in-flight cancellation,
@@ -181,17 +184,17 @@ export declare interface ExecuteResult {
  * `input` is standard-input payload and carries no NUL restriction.
  */
 export declare interface ExecuteSyncOptions {
-    /** The working directory. Default: the current working directory. */
+    /** Names the working directory. Default: the current working directory. */
     readonly workspace?: string;
-    /** Environment overrides merged over the parent environment; an `undefined` value unsets a key. */
+    /** Holds environment overrides merged over the parent environment; an `undefined` value unsets a key. */
     readonly environment?: Readonly<Record<string, string | undefined>>;
-    /** Standard-input payload written to the child, including any NUL characters. */
+    /** Holds the standard-input payload written to the child, including any NUL characters. */
     readonly input?: string;
-    /** Milliseconds before the host kills the root process alone. `0` or omitted disables the timeout. */
+    /** Sets the milliseconds before the host kills the root process alone. `0` or omitted disables the timeout. */
     readonly timeout?: number;
-    /** If `false`, return the result on failure instead of throwing. Default: `true`. */
+    /** If `true`, throw on failure; if `false`, return the result instead. Default: `true`. */
     readonly strict?: boolean;
-    /** Maximum captured bytes for stdout and for stderr, each. Default: {@link PROCESS_OUTPUT}. */
+    /** Sets the maximum captured bytes for stdout and for stderr, each. Default: {@link PROCESS_OUTPUT}. */
     readonly limit?: number;
 }
 
@@ -206,7 +209,7 @@ export declare interface ExecuteSyncOptions {
  * plain or property-only lookalike.
  *
  * @param value - The value to inspect
- * @returns True only for a `ProcessError` instance; false otherwise
+ * @returns True if the value is a `ProcessError` instance; false otherwise
  *
  * @example
  * ```ts
@@ -216,14 +219,14 @@ export declare interface ExecuteSyncOptions {
  */
 export declare function isProcessError(value: unknown): value is ProcessError;
 
-/** The default soft high-water mark in bytes for a supervised {@link ProcessInterface} line backlog. */
+/** Names the default soft high-water mark in bytes for a supervised {@link ProcessInterface} line backlog. */
 export declare const PROCESS_BACKLOG = 10485760;
 
-/** The window in milliseconds a termination waits for the child's native exit after the final kill. */
+/** Names the window in milliseconds a termination waits for the child's native exit after the final kill. */
 export declare const PROCESS_CONFIRMATION = 5000;
 
 /**
- * The default window in milliseconds the package waits for the child's read ends to close after
+ * Names the default window in milliseconds the package waits for the child's read ends to close after
  * the child's native exit or after a termination this package initiated, before cutting them off.
  *
  * @remarks
@@ -239,26 +242,26 @@ export declare const PROCESS_CONFIRMATION = 5000;
  */
 export declare const PROCESS_DRAIN = 1000;
 
-/** The machine-readable failure categories a {@link ProcessError} carries, in declaration order. */
+/** Lists the machine-readable failure categories a {@link ProcessError} carries, in declaration order. */
 export declare const PROCESS_ERROR_CODES: readonly ["spawn", "timeout", "input", "duplicate", "protocol", "invalid"];
 
-/** The default maximum retained stderr tail in bytes for a supervised {@link ProcessInterface}. */
+/** Names the default maximum retained stderr tail in bytes for a supervised {@link ProcessInterface}. */
 export declare const PROCESS_EVIDENCE = 2048;
 
-/** The default cooperative POSIX window in milliseconds between `SIGTERM` and `SIGKILL` during termination. */
+/** Names the default cooperative POSIX window in milliseconds between `SIGTERM` and `SIGKILL` during termination. */
 export declare const PROCESS_GRACE = 5000;
 
-/** The default maximum captured bytes for a one-shot run's stdout and stderr, each. */
+/** Names the default maximum captured bytes for a one-shot run's stdout and stderr, each. */
 export declare const PROCESS_OUTPUT = 10485760;
 
-/** The executable extensions a Windows lookup applies when the environment declares no `PATHEXT`. */
+/** Lists the executable extensions a Windows lookup applies when the environment declares no `PATHEXT`. */
 export declare const PROCESS_PATHEXT = ".COM;.EXE;.BAT;.CMD";
 
-/** The largest timer delay in milliseconds the host schedules without truncating it to one. */
+/** Names the largest timer delay in milliseconds the host schedules without truncating it to one. */
 export declare const PROCESS_TIMER = 2147483647;
 
 /**
- * The public contracts for `@orkestrel/process`: a typed child-process toolkit.
+ * Declares the public contracts for `@orkestrel/process`: a typed child-process toolkit.
  *
  * @remarks
  * The tiers divide by lifetime:
@@ -280,7 +283,7 @@ export declare const PROCESS_TIMER = 2147483647;
  * and plain `string` signal names). The Node implementations live in `@orkestrel/process/server`.
  */
 /**
- * One spawnable command: the executable, its argument vector, and optional environment overrides
+ * Represents one spawnable command: the executable, its argument vector, and optional environment overrides
  * and initial standard input.
  *
  * @remarks
@@ -298,19 +301,30 @@ export declare interface ProcessCommand {
     readonly arguments: readonly string[];
     readonly environment?: Readonly<Record<string, string | undefined>>;
     readonly input?: string;
-    /** If `true`, exclude the parent environment; on POSIX this leaves no `PATH`, while Windows libuv still injects a host set. */
+    /** If `true`, exclude the parent environment; if `false` or omitted, the overrides layer over it. On POSIX `true` leaves no `PATH`, while Windows libuv still injects a host set. */
     readonly isolated?: boolean;
 }
 
-/** A child-process failure with a stable machine-readable category. */
+/**
+ * Represents a child-process failure with a stable machine-readable category.
+ *
+ * @example
+ * ```ts
+ * const error = new ProcessError('git status refused', {
+ * 	code: 'invalid',
+ * 	context: { command: 'git status' },
+ * })
+ * error.code // 'invalid'
+ * ```
+ */
 export declare class ProcessError extends Error {
     readonly name = "ProcessError";
     readonly code: ProcessErrorCode;
     readonly context?: ProcessErrorContext;
-    /** The buffered run outcome, present when a one-shot run produced the failure. */
+    /** Carries the buffered run outcome, present when a one-shot run produced the failure. */
     readonly result?: ExecuteResult;
     /**
-     * Create a process error.
+     * Creates a process error.
      *
      * @param message - Human-readable failure description
      * @param options - Machine-readable category, optional context, optional cause, and optional run result
@@ -318,37 +332,37 @@ export declare class ProcessError extends Error {
     constructor(message: string, options: ProcessErrorOptions);
 }
 
-/** The machine-readable {@link ProcessError} categories, derived from {@link PROCESS_ERROR_CODES}. */
+/** Names the machine-readable {@link ProcessError} categories, derived from {@link PROCESS_ERROR_CODES}. */
 export declare type ProcessErrorCode = (typeof PROCESS_ERROR_CODES)[number];
 
-/** Structured context carried by a {@link ProcessError}. */
+/** Represents structured context carried by a {@link ProcessError}. */
 export declare interface ProcessErrorContext {
-    /** The registry id involved, for a manager failure. */
+    /** Names the registry id involved, for a manager failure. */
     readonly id?: string;
-    /** The command line involved, for a run or spawn failure. */
+    /** Names the command line involved, for a run or spawn failure. */
     readonly command?: string;
-    /** The child's exit code, when one was observed. */
+    /** Holds the child's exit code, when one was observed. */
     readonly code?: number | null;
-    /** The terminating signal, when one ended the child. */
+    /** Names the terminating signal, when one ended the child. */
     readonly signal?: string | null;
-    /** The rejected public input, for an input-validation failure. */
+    /** Carries the rejected public input, for an input-validation failure. */
     readonly value?: unknown;
 }
 
-/** Construction options for a {@link ProcessError}. */
+/** Configures a {@link ProcessError}. */
 export declare interface ProcessErrorOptions {
-    /** The stable machine-readable category. */
+    /** Names the stable machine-readable category. */
     readonly code: ProcessErrorCode;
-    /** Structured detail about the failure. */
+    /** Carries structured detail about the failure. */
     readonly context?: ProcessErrorContext;
-    /** The underlying cause, when one exists. */
+    /** Carries the underlying cause, when one exists. */
     readonly cause?: unknown;
-    /** The buffered run outcome, present when an {@link ExecuteResult} produced the failure. */
+    /** Carries the buffered run outcome, present when an {@link ExecuteResult} produced the failure. */
     readonly result?: ExecuteResult;
 }
 
 /**
- * The push observation surface of a {@link ProcessInterface} — the moments a fire-and-forget
+ * Represents the push observation surface of a {@link ProcessInterface} — the moments a fire-and-forget
  * observer subscribes to, alongside the `lines` stream and the `exit` promise.
  *
  * @remarks
@@ -362,16 +376,16 @@ export declare interface ProcessErrorOptions {
  * routed to that handler, never emitted as this `error` event.
  */
 export declare type ProcessEventMap = {
-    /** A decoded standard-error chunk arrived. */
+    /** Reports a decoded standard-error chunk arrived. */
     readonly stderr: readonly [chunk: string];
-    /** The child or its open standard-input channel reported a fault, carrying the host cause directly or through a `protocol` {@link ProcessError}. */
+    /** Reports a fault from the child or its open standard-input channel, carrying the host cause directly or through a `protocol` {@link ProcessError}. */
     readonly error: readonly [error: unknown];
-    /** The child settled — its terminal state, delivered once. */
+    /** Reports the child settled — its terminal state, delivered once. */
     readonly exit: readonly [exit: ProcessExit];
 };
 
 /**
- * The observed terminal state of a child process: its exit code or the signal that ended it, and
+ * Represents the observed terminal state of a child process: its exit code or the signal that ended it, and
  * how its observation ended.
  *
  * @remarks
@@ -382,16 +396,16 @@ export declare type ProcessEventMap = {
  * dropped lines and the drain bound cut stderr off.
  */
 export declare interface ProcessExit {
-    /** The exit code, or `null` when a signal ended the process. A spawn fault reports the host's negative errno for `Process` and `execute`. */
+    /** Holds the exit code, or `null` when a signal ended the process. A spawn fault reports the host's negative errno for `Process` and `execute`. */
     readonly code: number | null;
-    /** The terminating signal name, or `null` when the process exited on its own. */
+    /** Holds the terminating signal name, or `null` when the process exited on its own. */
     readonly signal: string | null;
-    /** True when the terminal moment arrived because the child's streams closed; false when the `drain` bound elapsed first and later diagnostics may have existed. */
+    /** Reports how the terminal moment arrived: true when the child's streams closed; false when the `drain` bound elapsed first and later diagnostics may have existed. */
     readonly drained: boolean;
 }
 
 /**
- * One supervised child process with framed output, a bounded backlog, and bounded termination.
+ * Represents one supervised child process with framed output, a bounded backlog, and bounded termination.
  *
  * @remarks
  * `lines` is pumped as soon as the child writes, and it is a single-consumer stream: each line goes
@@ -426,16 +440,16 @@ export declare interface ProcessExit {
  * supervisor inside that window reads the terminal state here.
  */
 export declare interface ProcessInterface {
-    /** The host process id, fixed when construction returns, or `undefined` when the spawn produced none. */
+    /** Holds the host process id, fixed when construction returns, or `undefined` when the spawn produced none. */
     readonly pid: number | undefined;
-    /** The exit code the host recorded, or `null` while the child has not exited and when a signal ended it. A spawn fault reports the host's negative errno. */
+    /** Holds the exit code the host recorded, or `null` while the child has not exited and when a signal ended it. A spawn fault reports the host's negative errno. */
     readonly code: number | null;
-    /** The terminating signal name the host recorded, or `null` while the child has not exited and when it exited on its own. */
+    /** Holds the terminating signal name the host recorded, or `null` while the child has not exited and when it exited on its own. */
     readonly signal: string | null;
-    /** The typed lifecycle observation surface. */
+    /** Holds the typed lifecycle observation surface. */
     readonly emitter: EmitterInterface<ProcessEventMap>;
     /**
-     * The captured stdout lines, in arrival order, for one consumer, ending at the terminal moment.
+     * Yields the captured stdout lines, in arrival order, for one consumer, ending at the terminal moment.
      *
      * @remarks
      * A line feed, a CRLF pair, and a bare carriage return each terminate a line, and a CRLF split
@@ -455,7 +469,7 @@ export declare interface ProcessInterface {
      */
     readonly lines: AsyncIterable<string>;
     /**
-     * The decoded byte-bounded stderr tail.
+     * Holds the decoded byte-bounded stderr tail.
      *
      * @remarks
      * The live tail before the terminal moment and the frozen value after it, on every path — a
@@ -465,10 +479,10 @@ export declare interface ProcessInterface {
      * the tail as of the cutoff, and later diagnostics may have existed.
      */
     readonly evidence: string;
-    /** True when the `lines` stream omitted output because a retention bound was reached. */
+    /** Reports whether the `lines` stream omitted output because a retention bound was reached. */
     readonly truncated: boolean;
     /**
-     * True after the `exit` promise settled.
+     * Reports whether the `exit` promise settled.
      *
      * @remarks
      * The terminal moment has arrived: `evidence` is frozen, `lines` has ended, and the
@@ -477,7 +491,7 @@ export declare interface ProcessInterface {
      */
     readonly settled: boolean;
     /**
-     * True after a termination began.
+     * Reports whether a termination began.
      *
      * @remarks
      * Monotonic. It turns true when `stop`, `destroy`, or an abort of the `signal` option begins a
@@ -488,7 +502,7 @@ export declare interface ProcessInterface {
      */
     readonly stopping: boolean;
     /**
-     * The terminal child state, delivered once.
+     * Settles with the terminal child state, delivered once.
      *
      * @remarks
      * Never rejects. It settles at the terminal moment: when the child's streams close, or when the
@@ -497,7 +511,7 @@ export declare interface ProcessInterface {
      */
     readonly exit: Promise<ProcessExit>;
     /**
-     * Write one line to the open standard-input channel.
+     * Writes one line to the open standard-input channel.
      *
      * @remarks
      * Never rejects. `true` means the host accepted the bytes without reporting a fault; it does not
@@ -511,11 +525,11 @@ export declare interface ProcessInterface {
      * for bytes the package is about to discard.
      *
      * @param text - The line text without its trailing newline
-     * @returns True when the host accepted the bytes without reporting a fault; false when the channel was closed, destroyed, ended, failed, or remained unconfirmed through `delivery`
+     * @returns True if the host accepted the bytes without reporting a fault; false otherwise (the channel was closed, destroyed, ended, failed, or the write remained unconfirmed through `delivery`)
      */
     send(text: string): Promise<boolean>;
     /**
-     * Terminate the child process tree, await its observed exit, and reach the terminal moment.
+     * Terminates the child process tree, awaits its observed exit, and reaches the terminal moment.
      *
      * @remarks
      * Never rejects. On Windows the whole tree is killed immediately through `taskkill`, with a
@@ -528,11 +542,11 @@ export declare interface ProcessInterface {
      * reaches the end of the stream instead of waiting on a child it already ended, and needs no
      * second call to release it.
      *
-     * @returns True when the child's native exit was observed; false when the confirmation deadline elapsed without it
+     * @returns True if the child's native exit was observed; false otherwise (the confirmation deadline elapsed without it)
      */
     stop(): Promise<boolean>;
     /**
-     * Stop the child, close its standard-input channel, reach the terminal moment, and destroy the
+     * Stops the child, closes its standard-input channel, reaches the terminal moment, and destroys the
      * observation emitter.
      *
      * @remarks
@@ -549,21 +563,21 @@ export declare interface ProcessInterface {
 }
 
 /**
- * The push observation surface of a {@link ProcessManagerInterface} — the fleet-level moments a
+ * Represents the push observation surface of a {@link ProcessManagerInterface} — the fleet-level moments a
  * fire-and-forget observer subscribes to.
  *
  * @remarks
  * Declared as a `type` alias so it satisfies the emitter's `EventMap` constraint structurally.
  */
 export declare type ProcessManagerEventMap = {
-    /** A child was launched under its id. */
+    /** Reports a child launched under its id. */
     readonly launch: readonly [id: string];
-    /** A child settled and left the registry — its id and terminal state. */
+    /** Reports a child settled and left the registry — its id and terminal state. */
     readonly exit: readonly [id: string, exit: ProcessExit];
 };
 
 /**
- * A keyed registry of live supervised child processes.
+ * Represents a keyed registry of live supervised child processes.
  *
  * @remarks
  * A child that settles removes itself from the registry, so `count` and `processes` reflect only
@@ -575,25 +589,25 @@ export declare type ProcessManagerEventMap = {
  * the `launch` and `exit` moments across every child.
  */
 export declare interface ProcessManagerInterface {
-    /** The typed fleet-level observation surface. */
+    /** Holds the typed fleet-level observation surface. */
     readonly emitter: EmitterInterface<ProcessManagerEventMap>;
-    /** The number of live children. */
+    /** Counts the live children. */
     readonly count: number;
     /**
-     * The live child under `id`, or `undefined` when none is.
+     * Returns the live child under `id`, or `undefined` when none is.
      *
      * @param id - The registry key
      * @returns The child, or `undefined`
      */
     process(id: string): ProcessInterface | undefined;
     /**
-     * A snapshot of every live child.
+     * Returns a snapshot of every live child.
      *
      * @returns The live children in launch order
      */
     processes(): readonly ProcessInterface[];
     /**
-     * Spawn and register one child under `id`.
+     * Spawns and registers one child under `id`.
      *
      * @remarks
      * Every option is read before the child is spawned, so a caller's own option getter runs while
@@ -611,27 +625,27 @@ export declare interface ProcessManagerInterface {
      */
     launch(id: string, options: ProcessOptions): ProcessInterface;
     /**
-     * Terminate the named children and await their exit.
+     * Terminates the named children and awaits their exit.
      *
      * @param ids - The registry keys to stop
-     * @returns True when every named child was live and its exit was confirmed; false otherwise
+     * @returns True if every named child was live and its exit was confirmed; false otherwise
      */
     stop(ids: readonly string[]): Promise<boolean>;
     /**
-     * Terminate one child and await its exit.
+     * Terminates one child and awaits its exit.
      *
      * @param id - The registry key to stop
-     * @returns True when the child was live and its exit was confirmed; false when the id was not live or the confirmation deadline elapsed
+     * @returns True if the child was live and its exit was confirmed; false otherwise (the id was not live, or the confirmation deadline elapsed)
      */
     stop(id: string): Promise<boolean>;
     /**
-     * Terminate every live child and await their exit.
+     * Terminates every live child and awaits their exit.
      *
      * @returns A promise that resolves after every child stops
      */
     stop(): Promise<void>;
     /**
-     * Stop every child, then destroy the registry emitter last.
+     * Stops every child, then destroys the registry emitter last.
      *
      * @remarks
      * Always resolves, and refuses a later `launch` with a {@link ProcessError} coded `protocol`.
@@ -645,7 +659,7 @@ export declare interface ProcessManagerInterface {
 }
 
 /**
- * Construction options for a {@link ProcessManagerInterface}.
+ * Configures a {@link ProcessManagerInterface}.
  *
  * @remarks
  * `on` installs initial {@link ProcessManagerEventMap} listeners and `error` receives isolated
@@ -657,7 +671,7 @@ export declare interface ProcessManagerOptions {
 }
 
 /**
- * Construction options for one supervised child process.
+ * Configures one supervised child process.
  *
  * @remarks
  * `grace` is the cooperative window between `SIGTERM` and `SIGKILL` on a POSIX host; Windows has no
@@ -685,26 +699,26 @@ export declare interface ProcessOptions {
     readonly on?: EmitterHooks<ProcessEventMap>;
     readonly error?: EmitterErrorHandler;
     readonly command: ProcessCommand;
-    /** The working directory the child runs in. */
+    /** Names the working directory the child runs in. */
     readonly workspace: string;
-    /** Cooperative POSIX window in milliseconds between `SIGTERM` and `SIGKILL`. Default: {@link PROCESS_GRACE}. */
+    /** Sets the cooperative POSIX window in milliseconds between `SIGTERM` and `SIGKILL`. Default: {@link PROCESS_GRACE}. */
     readonly grace?: number;
-    /** Milliseconds the package waits for the child's read ends to close after the native exit or an initiated termination, before cutting them off; `0` cuts them off as soon as the bound is armed. Default: {@link PROCESS_DRAIN}. */
+    /** Sets the milliseconds the package waits for the child's read ends to close after the native exit or an initiated termination, before cutting them off; `0` cuts them off as soon as the bound is armed. Default: {@link PROCESS_DRAIN}. */
     readonly drain?: number;
-    /** Maximum retained stderr tail in bytes. Default: {@link PROCESS_EVIDENCE}. */
+    /** Sets the maximum retained stderr tail in bytes. Default: {@link PROCESS_EVIDENCE}. */
     readonly evidence?: number;
-    /** Soft high-water mark in bytes for the unconsumed `lines` backlog; termination retains at most twice this value. Default: {@link PROCESS_BACKLOG}. */
+    /** Sets the soft high-water mark in bytes for the unconsumed `lines` backlog; termination retains at most twice this value. Default: {@link PROCESS_BACKLOG}. */
     readonly backlog?: number;
-    /** Milliseconds an unconfirmed {@link ProcessInterface.send} waits before resolving `false`. `0` or omitted disables the bound. */
+    /** Sets the milliseconds an unconfirmed {@link ProcessInterface.send} waits before resolving `false`. `0` or omitted disables the bound. */
     readonly delivery?: number;
     /** If `true`, stdin stays open for {@link ProcessInterface.send}; if `false` or omitted, stdin closes after any initial `input`. */
     readonly writable?: boolean;
-    /** Aborting this signal terminates the child through the same bounded `stop`. */
+    /** Terminates the child through the same bounded `stop` when this signal aborts. */
     readonly signal?: AbortSignal;
 }
 
 /**
- * The push observation surface of a {@link SessionInterface} — the moments a byte-oriented observer
+ * Represents the push observation surface of a {@link SessionInterface} — the moments a byte-oriented observer
  * subscribes to, alongside the `ending` and `exit` promises.
  *
  * @remarks
@@ -727,18 +741,18 @@ export declare interface ProcessOptions {
  * `error` event.
  */
 export declare type SessionEventMap = {
-    /** A standard-output chunk arrived, as an owned `Uint8Array` the consumer may keep and mutate. */
+    /** Reports a standard-output chunk arrived, as an owned `Uint8Array` the consumer may keep and mutate. */
     readonly stdout: readonly [chunk: Uint8Array];
-    /** A decoded standard-error chunk arrived. */
+    /** Reports a decoded standard-error chunk arrived. */
     readonly stderr: readonly [chunk: string];
-    /** The child or its open standard-input channel reported a fault, carrying the host cause directly or through a `protocol` {@link ProcessError}. */
+    /** Reports a fault from the child or its open standard-input channel, carrying the host cause directly or through a `protocol` {@link ProcessError}. */
     readonly error: readonly [error: unknown];
-    /** The child settled — its terminal state, delivered once. */
+    /** Reports the child settled — its terminal state, delivered once. */
     readonly exit: readonly [exit: ProcessExit];
 };
 
 /**
- * One supervised child process read as raw bytes, with an open standard-input channel and bounded
+ * Represents one supervised child process read as raw bytes, with an open standard-input channel and bounded
  * termination.
  *
  * @remarks
@@ -770,16 +784,16 @@ export declare type SessionEventMap = {
  * the id.
  */
 export declare interface SessionInterface {
-    /** The host process id, fixed when construction returns, or `undefined` when the spawn produced none. */
+    /** Holds the host process id, fixed when construction returns, or `undefined` when the spawn produced none. */
     readonly pid: number | undefined;
-    /** The exit code the host recorded, or `null` while the child has not exited and when a signal ended it. A spawn fault reports the host's negative errno. */
+    /** Holds the exit code the host recorded, or `null` while the child has not exited and when a signal ended it. A spawn fault reports the host's negative errno. */
     readonly code: number | null;
-    /** The terminating signal name the host recorded, or `null` while the child has not exited and when it exited on its own. */
+    /** Holds the terminating signal name the host recorded, or `null` while the child has not exited and when it exited on its own. */
     readonly signal: string | null;
-    /** The typed lifecycle observation surface. */
+    /** Holds the typed lifecycle observation surface. */
     readonly emitter: EmitterInterface<SessionEventMap>;
     /**
-     * The decoded byte-bounded stderr tail.
+     * Holds the decoded byte-bounded stderr tail.
      *
      * @remarks
      * The live tail before the terminal moment and the frozen value after it, on every path — a
@@ -789,7 +803,7 @@ export declare interface SessionInterface {
      */
     readonly evidence: string;
     /**
-     * True after the `exit` promise settled.
+     * Reports whether the `exit` promise settled.
      *
      * @remarks
      * The terminal moment has arrived: `evidence` is frozen, no further `stdout` or `stderr` event
@@ -798,7 +812,7 @@ export declare interface SessionInterface {
      */
     readonly settled: boolean;
     /**
-     * True after a termination began.
+     * Reports whether a termination began.
      *
      * @remarks
      * Monotonic. It turns true when `stop`, `destroy`, or an abort of the `signal` option begins a
@@ -808,7 +822,7 @@ export declare interface SessionInterface {
      */
     readonly stopping: boolean;
     /**
-     * The child's own ending, awaited without the terminal moment's drain window.
+     * Settles at the child's own ending, awaited without the terminal moment's drain window.
      *
      * @remarks
      * Never rejects, and resolves no value: `code` and `signal` carry the terminal facts as soon as
@@ -821,7 +835,7 @@ export declare interface SessionInterface {
      */
     readonly ending: Promise<void>;
     /**
-     * The terminal child state, delivered once.
+     * Settles with the terminal child state, delivered once.
      *
      * @remarks
      * Never rejects. It settles at the terminal moment: when the child's streams close, or when the
@@ -830,7 +844,7 @@ export declare interface SessionInterface {
      */
     readonly exit: Promise<ProcessExit>;
     /**
-     * Write raw bytes to the open standard-input channel.
+     * Writes raw bytes to the open standard-input channel.
      *
      * @remarks
      * Never rejects, and adds no framing: the bytes reach the child exactly as given, with no
@@ -847,11 +861,11 @@ export declare interface SessionInterface {
      * promise settles: bytes mutated inside that window are the bytes the child receives.
      *
      * @param bytes - The payload to write, already framed by the caller
-     * @returns True when the host accepted the bytes without reporting a fault; false when the channel was closed, destroyed, ended, failed, or remained unconfirmed through `delivery`
+     * @returns True if the host accepted the bytes without reporting a fault; false otherwise (the channel was closed, destroyed, ended, failed, or the write remained unconfirmed through `delivery`)
      */
     write(bytes: Uint8Array): Promise<boolean>;
     /**
-     * Close the standard-input channel and leave the child running.
+     * Closes the standard-input channel and leaves the child running.
      *
      * @remarks
      * Never rejects, and terminates nothing: `stopping` stays false, no signal is sent, no drain
@@ -872,7 +886,7 @@ export declare interface SessionInterface {
      */
     end(): Promise<void>;
     /**
-     * Terminate the child process tree, await its observed exit, and reach the terminal moment.
+     * Terminates the child process tree, awaits its observed exit, and reaches the terminal moment.
      *
      * @remarks
      * Never rejects. On Windows the whole tree is killed immediately through `taskkill`, with a
@@ -883,11 +897,11 @@ export declare interface SessionInterface {
      * `stdout` and `stderr` events stop, and `exit` settles. A caller that stops a child and keeps
      * listening therefore reaches the end of the stream and needs no second call to release it.
      *
-     * @returns True when the child's native exit was observed; false when the confirmation deadline elapsed without it
+     * @returns True if the child's native exit was observed; false otherwise (the confirmation deadline elapsed without it)
      */
     stop(): Promise<boolean>;
     /**
-     * Stop the child, close its standard-input channel, reach the terminal moment, and destroy the
+     * Stops the child, closes its standard-input channel, reaches the terminal moment, and destroys the
      * observation emitter.
      *
      * @remarks
@@ -904,7 +918,7 @@ export declare interface SessionInterface {
 }
 
 /**
- * Construction options for one raw byte session over a supervised child.
+ * Configures one raw byte session over a supervised child.
  *
  * @remarks
  * This is {@link ProcessOptions} without `backlog` and without `writable`. A session frames nothing
@@ -924,22 +938,22 @@ export declare interface SessionOptions {
     readonly on?: EmitterHooks<SessionEventMap>;
     readonly error?: EmitterErrorHandler;
     readonly command: ProcessCommand;
-    /** The working directory the child runs in. */
+    /** Names the working directory the child runs in. */
     readonly workspace: string;
-    /** Cooperative POSIX window in milliseconds between `SIGTERM` and `SIGKILL`. Default: {@link PROCESS_GRACE}. */
+    /** Sets the cooperative POSIX window in milliseconds between `SIGTERM` and `SIGKILL`. Default: {@link PROCESS_GRACE}. */
     readonly grace?: number;
-    /** Milliseconds the package waits for the child's read ends to close after the native exit or an initiated termination, before cutting them off; `0` cuts them off as soon as the bound is armed. Default: {@link PROCESS_DRAIN}. */
+    /** Sets the milliseconds the package waits for the child's read ends to close after the native exit or an initiated termination, before cutting them off; `0` cuts them off as soon as the bound is armed. Default: {@link PROCESS_DRAIN}. */
     readonly drain?: number;
-    /** Maximum retained stderr tail in bytes. Default: {@link PROCESS_EVIDENCE}. */
+    /** Sets the maximum retained stderr tail in bytes. Default: {@link PROCESS_EVIDENCE}. */
     readonly evidence?: number;
-    /** Milliseconds an unconfirmed {@link SessionInterface.write} waits before resolving `false`. `0` or omitted disables the bound. */
+    /** Sets the milliseconds an unconfirmed {@link SessionInterface.write} waits before resolving `false`. `0` or omitted disables the bound. */
     readonly delivery?: number;
-    /** Aborting this signal terminates the child through the same bounded `stop`. */
+    /** Terminates the child through the same bounded `stop` when this signal aborts. */
     readonly signal?: AbortSignal;
 }
 
 /**
- * The resolved spawn form of one command: the executable to launch, the argument vector to pass,
+ * Represents the resolved spawn form of one command: the executable to launch, the argument vector to pass,
  * and whether the host receives that vector verbatim.
  *
  * @remarks