effect 4.0.0-beta.70 → 4.0.0-beta.72

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

@@ -2,177 +2,30 @@
  * @since 4.0.0
  */
 /**
- * Effectful key/value storage for persistence backends.
- *
- * This module defines the `KeyValueStore` service used by the persistence
- * package when a simple string or binary store is enough. It is useful for
- * lightweight durable state, browser storage, local file-backed data, SQL
- * tables, test stores, and as the storage primitive underneath higher-level
- * persistence APIs.
- *
- * Values are stored as strings or `Uint8Array`s, and `toSchemaStore` adds a
- * schema-aware JSON layer for typed values. Schema changes can make existing
- * JSON fail to decode, and `prefix` should be used to separate namespaces when
- * several logical stores share the same backend. This service does not provide
- * native TTL support; higher-level persistence layers encode expiration
- * metadata in stored values when they need TTLs.
- *
- * Backend behavior is intentionally small but not identical: Web Storage is
- * string-only, `makeStringOnly` stores binary values as base64, filesystem
- * keys become encoded file names, SQL stores value type metadata in a table,
- * and the memory layer is process-local. Choose keys, prefixes, table names,
- * and value formats with those backend constraints in mind.
- *
  * @since 4.0.0
  */
 export * as KeyValueStore from "./KeyValueStore.ts";
 /**
- * Defines the request-side contract used by the persistence layer.
- *
- * A `Persistable` request is a `PrimaryKey` value that carries the success and
- * error schemas needed to encode and decode the stored `Exit` for that request.
- * Persisted request resolvers and `PersistedCache` use this metadata to restore
- * previous lookup results from a backing store before running the lookup again.
- *
- * Use `Class` for cacheable or durable requests whose results can safely be
- * reused across fibers, processes, or restarts. The request primary key is the
- * entry id inside a persistence store, so it should be stable, collision-free,
- * and usually include a request-specific prefix. The `storeId` is configured on
- * `Persistence` or `PersistedCache`; it selects the backing store namespace and
- * is separate from the request primary key.
- *
- * Success and error schemas are encoded with the JSON codec, so persisted
- * values must be representable by those schemas and any required schema services
- * must be available where the store reads or writes entries. Changing a schema,
- * primary-key format, or store id can make existing persisted values fail to
- * decode or stop being found, so treat those changes as persistence migrations.
- *
  * @since 4.0.0
  */
 export * as Persistable from "./Persistable.ts";
 /**
- * Persistent caching for `Persistable` request keys.
- *
- * A `PersistedCache` combines a scoped in-memory `Cache` with a named
- * `Persistence` store. It is useful for expensive or idempotent lookups such as
- * remote API calls, database reads, and request results that should be reused
- * across fibers, process restarts, or multiple workers sharing the same backing
- * store.
- *
- * The persistent `timeToLive` is evaluated for the stored `Exit`, so successes
- * and failures can be cached with different lifetimes. The in-memory cache has
- * its own `inMemoryTTL` and capacity, and `invalidate` removes both the
- * persisted value and the in-memory entry. Persisted values are encoded with
- * the key's success and error schemas and stored under the key's primary key, so
- * schema changes, primary-key changes, or store-id collisions can make old
- * entries fail to decode until they are invalidated or written under a new
- * `storeId`.
- *
  * @since 4.0.0
  */
 export * as PersistedCache from "./PersistedCache.ts";
 /**
- * Schema-aware persisted queues for background work.
- *
- * A `PersistedQueue` stores JSON-encoded values in a named queue and lets
- * workers `take` one value at a time inside a scoped processing window. It is
- * useful for durable handoffs, background jobs, outbox-style integrations, and
- * workloads where failed work should be retried across fibers, process
- * restarts, or multiple workers sharing Redis or SQL.
- *
- * Delivery is at-least-once: a handler that fails, is interrupted, or loses its
- * backing-store lock may see the same element again until `maxAttempts` is
- * reached. Use stable custom ids when offering idempotent work, and choose ids
- * that are collision-free for the backing store because stores can enforce
- * uniqueness at the queue, prefix, or table level. Ordering is intentionally a
- * store-level concern; retries, lock expiration, polling, and multiple workers
- * can move entries behind newer work, so handlers should not rely on strict
- * FIFO processing.
- *
- * Values are encoded and decoded with the supplied schema using the JSON codec,
- * so schema services must be available when offering and taking values. Changing
- * a queue name, schema, Redis prefix, SQL table, or id format is a persistence
- * migration: old entries may decode differently, stop being visible, or collide
- * with new entries. The memory store is process-local and volatile, while Redis
- * and SQL stores use leases that should be tuned for the expected processing
- * time.
- *
  * @since 4.0.0
  */
 export * as PersistedQueue from "./PersistedQueue.ts";
 /**
- * Durable storage for encoded `Persistable` request results.
- *
- * The `Persistence` service creates scoped stores that read and write
- * schema-encoded `Exit` values keyed by each request's `PrimaryKey`. It is the
- * lower-level persistence layer used by `PersistedCache` and similar request
- * workflows to reuse expensive or idempotent lookup results across fibers,
- * process restarts, and workers that share a backing store.
- *
- * Each store is selected by a `storeId`, while each entry id comes from the
- * request's primary key. Keep both stable and collision-free: changing the
- * `storeId`, the primary-key format, or the success/error schemas is a
- * persistence migration, because old entries may stop being found or fail to
- * decode. Values are encoded with the request's success and error schemas using
- * the JSON codec, so any required schema services must be available at store
- * read and write time, and the backing value must stay JSON-compatible.
- *
- * TTLs are computed from the stored `Exit` and request key. Infinite TTLs are
- * stored without an expiration, finite TTLs become backing-store expirations,
- * and zero or negative TTLs skip the write entirely. Backing layers provide
- * process-local memory, `KeyValueStore`, Redis, and SQL implementations; store
- * ids are used as prefixes, table names, or SQL partitions and should be
- * chosen with the target backing store in mind.
- *
  * @since 4.0.0
  */
 export * as Persistence from "./Persistence.ts";
 /**
- * Persistent rate limiting for effects that need to coordinate token
- * consumption through a shared `RateLimiterStore`.
- *
- * The module exposes a `RateLimiter` service that can consume tokens for
- * string keys using either fixed-window counters or token-bucket state. It is
- * useful for protecting external APIs, enforcing per-user or per-tenant quotas,
- * throttling job workers, and coordinating limits across multiple fibers or
- * processes when they share the Redis-backed store. The helpers can fail fast
- * with `RateLimiterError`, return a delay to apply yourself, or wrap an effect
- * so it waits before continuing.
- *
- * Rate-limit keys and Redis prefixes are part of the persistence namespace, so
- * choose stable, collision-free values. The in-memory store is process-local
- * and is only coordinated inside one runtime, while the Redis store uses Lua
- * scripts for atomic updates under concurrent consumers. Time is measured with
- * the Effect `Clock`, windows are clamped to at least one millisecond, and
- * refill calculations use millisecond granularity.
- *
- * Fixed-window state is TTL-driven: rejected `fail` attempts do not extend the
- * current TTL, and Redis fixed-window keys expire automatically. Token-bucket
- * state keeps the remaining token count and last-refill time instead of using a
- * TTL, so high-cardinality dynamic keys may need an external cleanup or bounded
- * key strategy. With `onExceeded: "delay"`, overflow can be recorded so callers
- * should actually sleep for the returned delay, or use the provided accessors.
- *
  * @since 4.0.0
  */
 export * as RateLimiter from "./RateLimiter.ts";
 /**
- * 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
  */
 export * as Redis from "./Redis.ts";

package/dist/unstable/persistence/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/unstable/persistence/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/unstable/persistence/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA"}

package/dist/unstable/persistence/index.js

@@ -3,177 +3,30 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
- * Effectful key/value storage for persistence backends.
- *
- * This module defines the `KeyValueStore` service used by the persistence
- * package when a simple string or binary store is enough. It is useful for
- * lightweight durable state, browser storage, local file-backed data, SQL
- * tables, test stores, and as the storage primitive underneath higher-level
- * persistence APIs.
- *
- * Values are stored as strings or `Uint8Array`s, and `toSchemaStore` adds a
- * schema-aware JSON layer for typed values. Schema changes can make existing
- * JSON fail to decode, and `prefix` should be used to separate namespaces when
- * several logical stores share the same backend. This service does not provide
- * native TTL support; higher-level persistence layers encode expiration
- * metadata in stored values when they need TTLs.
- *
- * Backend behavior is intentionally small but not identical: Web Storage is
- * string-only, `makeStringOnly` stores binary values as base64, filesystem
- * keys become encoded file names, SQL stores value type metadata in a table,
- * and the memory layer is process-local. Choose keys, prefixes, table names,
- * and value formats with those backend constraints in mind.
- *
  * @since 4.0.0
  */
 export * as KeyValueStore from "./KeyValueStore.js";
 /**
- * Defines the request-side contract used by the persistence layer.
- *
- * A `Persistable` request is a `PrimaryKey` value that carries the success and
- * error schemas needed to encode and decode the stored `Exit` for that request.
- * Persisted request resolvers and `PersistedCache` use this metadata to restore
- * previous lookup results from a backing store before running the lookup again.
- *
- * Use `Class` for cacheable or durable requests whose results can safely be
- * reused across fibers, processes, or restarts. The request primary key is the
- * entry id inside a persistence store, so it should be stable, collision-free,
- * and usually include a request-specific prefix. The `storeId` is configured on
- * `Persistence` or `PersistedCache`; it selects the backing store namespace and
- * is separate from the request primary key.
- *
- * Success and error schemas are encoded with the JSON codec, so persisted
- * values must be representable by those schemas and any required schema services
- * must be available where the store reads or writes entries. Changing a schema,
- * primary-key format, or store id can make existing persisted values fail to
- * decode or stop being found, so treat those changes as persistence migrations.
- *
  * @since 4.0.0
  */
 export * as Persistable from "./Persistable.js";
 /**
- * Persistent caching for `Persistable` request keys.
- *
- * A `PersistedCache` combines a scoped in-memory `Cache` with a named
- * `Persistence` store. It is useful for expensive or idempotent lookups such as
- * remote API calls, database reads, and request results that should be reused
- * across fibers, process restarts, or multiple workers sharing the same backing
- * store.
- *
- * The persistent `timeToLive` is evaluated for the stored `Exit`, so successes
- * and failures can be cached with different lifetimes. The in-memory cache has
- * its own `inMemoryTTL` and capacity, and `invalidate` removes both the
- * persisted value and the in-memory entry. Persisted values are encoded with
- * the key's success and error schemas and stored under the key's primary key, so
- * schema changes, primary-key changes, or store-id collisions can make old
- * entries fail to decode until they are invalidated or written under a new
- * `storeId`.
- *
  * @since 4.0.0
  */
 export * as PersistedCache from "./PersistedCache.js";
 /**
- * Schema-aware persisted queues for background work.
- *
- * A `PersistedQueue` stores JSON-encoded values in a named queue and lets
- * workers `take` one value at a time inside a scoped processing window. It is
- * useful for durable handoffs, background jobs, outbox-style integrations, and
- * workloads where failed work should be retried across fibers, process
- * restarts, or multiple workers sharing Redis or SQL.
- *
- * Delivery is at-least-once: a handler that fails, is interrupted, or loses its
- * backing-store lock may see the same element again until `maxAttempts` is
- * reached. Use stable custom ids when offering idempotent work, and choose ids
- * that are collision-free for the backing store because stores can enforce
- * uniqueness at the queue, prefix, or table level. Ordering is intentionally a
- * store-level concern; retries, lock expiration, polling, and multiple workers
- * can move entries behind newer work, so handlers should not rely on strict
- * FIFO processing.
- *
- * Values are encoded and decoded with the supplied schema using the JSON codec,
- * so schema services must be available when offering and taking values. Changing
- * a queue name, schema, Redis prefix, SQL table, or id format is a persistence
- * migration: old entries may decode differently, stop being visible, or collide
- * with new entries. The memory store is process-local and volatile, while Redis
- * and SQL stores use leases that should be tuned for the expected processing
- * time.
- *
  * @since 4.0.0
  */
 export * as PersistedQueue from "./PersistedQueue.js";
 /**
- * Durable storage for encoded `Persistable` request results.
- *
- * The `Persistence` service creates scoped stores that read and write
- * schema-encoded `Exit` values keyed by each request's `PrimaryKey`. It is the
- * lower-level persistence layer used by `PersistedCache` and similar request
- * workflows to reuse expensive or idempotent lookup results across fibers,
- * process restarts, and workers that share a backing store.
- *
- * Each store is selected by a `storeId`, while each entry id comes from the
- * request's primary key. Keep both stable and collision-free: changing the
- * `storeId`, the primary-key format, or the success/error schemas is a
- * persistence migration, because old entries may stop being found or fail to
- * decode. Values are encoded with the request's success and error schemas using
- * the JSON codec, so any required schema services must be available at store
- * read and write time, and the backing value must stay JSON-compatible.
- *
- * TTLs are computed from the stored `Exit` and request key. Infinite TTLs are
- * stored without an expiration, finite TTLs become backing-store expirations,
- * and zero or negative TTLs skip the write entirely. Backing layers provide
- * process-local memory, `KeyValueStore`, Redis, and SQL implementations; store
- * ids are used as prefixes, table names, or SQL partitions and should be
- * chosen with the target backing store in mind.
- *
  * @since 4.0.0
  */
 export * as Persistence from "./Persistence.js";
 /**
- * Persistent rate limiting for effects that need to coordinate token
- * consumption through a shared `RateLimiterStore`.
- *
- * The module exposes a `RateLimiter` service that can consume tokens for
- * string keys using either fixed-window counters or token-bucket state. It is
- * useful for protecting external APIs, enforcing per-user or per-tenant quotas,
- * throttling job workers, and coordinating limits across multiple fibers or
- * processes when they share the Redis-backed store. The helpers can fail fast
- * with `RateLimiterError`, return a delay to apply yourself, or wrap an effect
- * so it waits before continuing.
- *
- * Rate-limit keys and Redis prefixes are part of the persistence namespace, so
- * choose stable, collision-free values. The in-memory store is process-local
- * and is only coordinated inside one runtime, while the Redis store uses Lua
- * scripts for atomic updates under concurrent consumers. Time is measured with
- * the Effect `Clock`, windows are clamped to at least one millisecond, and
- * refill calculations use millisecond granularity.
- *
- * Fixed-window state is TTL-driven: rejected `fail` attempts do not extend the
- * current TTL, and Redis fixed-window keys expire automatically. Token-bucket
- * state keeps the remaining token count and last-refill time instead of using a
- * TTL, so high-cardinality dynamic keys may need an external cleanup or bounded
- * key strategy. With `onExceeded: "delay"`, overflow can be recorded so callers
- * should actually sleep for the returned delay, or use the provided accessors.
- *
  * @since 4.0.0
  */
 export * as RateLimiter from "./RateLimiter.js";
 /**
- * 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
  */
 export * as Redis from "./Redis.js";

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["KeyValueStore","Persistable","PersistedCache","PersistedQueue","Persistence","RateLimiter","Redis"],"sources":["../../../src/unstable/persistence/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKA,aAAa,MAAM,oBAAoB;AAEnD;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKC,KAAK,MAAM,YAAY","ignoreList":[]}
+{"version":3,"file":"index.js","names":["KeyValueStore","Persistable","PersistedCache","PersistedQueue","Persistence","RateLimiter","Redis"],"sources":["../../../src/unstable/persistence/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,KAAK,MAAM,YAAY","ignoreList":[]}

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

@@ -376,21 +376,21 @@ export type TemplateExpressionItem = string | number | boolean;
  */
 export type TemplateExpression = TemplateExpressionItem | ReadonlyArray<TemplateExpressionItem>;
 /**
- * Check if a value is a `Command`.
+ * Checks whether a value is a `Command`.
  *
  * @category guards
  * @since 4.0.0
  */
 export declare const isCommand: (u: unknown) => u is Command;
 /**
- * Check if a command is a `StandardCommand`.
+ * Checks whether a command is a `StandardCommand`.
  *
  * @category guards
  * @since 4.0.0
  */
 export declare const isStandardCommand: (command: Command) => command is StandardCommand;
 /**
- * Check if a command is a `PipedCommand`.
+ * Checks whether a command is a `PipedCommand`.
  *
  * @category guards
  * @since 4.0.0
@@ -558,7 +558,7 @@ export declare const make: {
     (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>): StandardCommand;
 };
 /**
- * Pipe the output of one command to the input of another.
+ * Pipes the output of one command to the input of another.
  *
  * **Details**
  *
@@ -591,7 +591,7 @@ export declare const make: {
  */
 export declare const pipeTo: {
     /**
-     * Pipe the output of one command to the input of another.
+     * Pipes the output of one command to the input of another.
      *
      * **Details**
      *
@@ -624,7 +624,7 @@ export declare const pipeTo: {
      */
     (that: Command, options?: PipeOptions): (self: Command) => PipedCommand;
     /**
-     * Pipe the output of one command to the input of another.
+     * Pipes the output of one command to the input of another.
      *
      * **Details**
      *
@@ -658,7 +658,7 @@ export declare const pipeTo: {
     (self: Command, that: Command, options?: PipeOptions): PipedCommand;
 };
 /**
- * Prefix a command with another command.
+ * Prepends another command to a command.
  *
  * **Details**
  *
@@ -683,7 +683,7 @@ export declare const pipeTo: {
  */
 export declare const prefix: {
     /**
-     * Prefix a command with another command.
+     * Prepends another command to a command.
      *
      * **Details**
      *
@@ -708,7 +708,7 @@ export declare const prefix: {
      */
     (command: string, args?: ReadonlyArray<string>): (self: Command) => Command;
     /**
-     * Prefix a command with another command.
+     * Prepends another command to a command.
      *
      * **Details**
      *
@@ -733,7 +733,7 @@ export declare const prefix: {
      */
     (templates: TemplateStringsArray, ...expressions: ReadonlyArray<TemplateExpression>): (self: Command) => Command;
     /**
-     * Prefix a command with another command.
+     * Prepends another command to a command.
      *
      * **Details**
      *
@@ -759,7 +759,7 @@ export declare const prefix: {
     (self: Command, command: string, args?: ReadonlyArray<string>): Command;
 };
 /**
- * Set the current working directory for a command.
+ * Sets the current working directory for a command.
  *
  * **Details**
  *
@@ -780,7 +780,7 @@ export declare const prefix: {
  */
 export declare const setCwd: {
     /**
-     * Set the current working directory for a command.
+     * Sets the current working directory for a command.
      *
      * **Details**
      *
@@ -801,7 +801,7 @@ export declare const setCwd: {
      */
     (cwd: string): (self: Command) => Command;
     /**
-     * Set the current working directory for a command.
+     * Sets the current working directory for a command.
      *
      * **Details**
      *
@@ -890,7 +890,7 @@ export declare const setEnv: {
     (self: Command, env: Record<string, string>): Command;
 };
 /**
- * Parse an fd name like "fd3" to its numeric index.
+ * Parses an fd name like "fd3" to its numeric index.
  * Returns undefined if the name is invalid.
  *
  * @category utils

package/dist/unstable/process/ChildProcess.js

@@ -60,21 +60,21 @@ const Proto = {
   [TypeId]: TypeId
 };
 /**
- * Check if a value is a `Command`.
+ * Checks whether a value is a `Command`.
  *
  * @category guards
  * @since 4.0.0
  */
 export const isCommand = u => Predicate.hasProperty(u, TypeId);
 /**
- * Check if a command is a `StandardCommand`.
+ * Checks whether a command is a `StandardCommand`.
  *
  * @category guards
  * @since 4.0.0
  */
 export const isStandardCommand = command => command._tag === "StandardCommand";
 /**
- * Check if a command is a `PipedCommand`.
+ * Checks whether a command is a `PipedCommand`.
  *
  * @category guards
  * @since 4.0.0
@@ -148,7 +148,7 @@ export const make = function make(...args) {
   return makeStandardCommand(command, cmdArgs, options);
 };
 /**
- * Pipe the output of one command to the input of another.
+ * Pipes the output of one command to the input of another.
  *
  * **Details**
  *
@@ -181,7 +181,7 @@ export const make = function make(...args) {
  */
 export const pipeTo = /*#__PURE__*/dual(args => isCommand(args[0]) && isCommand(args[1]), (self, that, options) => makePipedCommand(self, that, options ?? {}));
 /**
- * Prefix a command with another command.
+ * Prepends another command to a command.
  *
  * **Details**
  *
@@ -241,7 +241,7 @@ const applyPrefix = (self, prefixSpec) => {
   }
 };
 /**
- * Set the current working directory for a command.
+ * Sets the current working directory for a command.
  *
  * **Details**
  *
@@ -320,7 +320,7 @@ const isTemplateString = u => Array.isArray(u) && "raw" in u && Array.isArray(u.
 // Utilities
 // =============================================================================
 /**
- * Parse an fd name like "fd3" to its numeric index.
+ * Parses an fd name like "fd3" to its numeric index.
  * Returns undefined if the name is invalid.
  *
  * @category utils

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

@@ -1,8 +1,20 @@
 /**
- * A module providing a generic service interface for spawning child processes.
+ * Service contract and helpers for running child processes through Effect.
  *
- * This module provides the `ChildProcessSpawner` service tag which can be
- * implemented by platform-specific packages (e.g., Node.js).
+ * This module defines the {@link ChildProcessSpawner} service used by child
+ * process commands to start operating-system processes. A spawner turns a
+ * command description into a {@link ChildProcessHandle}, which exposes scoped
+ * lifecycle operations: write to stdin, stream stdout and stderr, wait for the
+ * exit code, kill the process, inspect whether it is still running, and
+ * temporarily unreference it from the parent process.
+ *
+ * Use this module when implementing a platform-specific process backend or
+ * when code needs direct access to the process service. Most applications build
+ * commands with the `ChildProcess` module; this service is the lower-level
+ * execution boundary and also provides convenience methods for collecting exit
+ * codes, strings, and output lines. The {@link make} constructor derives those
+ * helpers from one primitive `spawn` implementation, so adapters only need to
+ * supply process creation.
  *
  * @since 4.0.0
  */
@@ -22,7 +34,7 @@ import type { Command, KillOptions } from "./ChildProcess.ts";
  */
 export type ExitCode = Brand.Branded<number, "ExitCode">;
 /**
- * Brand constructor for child process `ExitCode` values.
+ * Constructs branded child process `ExitCode` values.
  *
  * @category constructors
  * @since 4.0.0
@@ -37,7 +49,7 @@ export declare const ExitCode: Brand.Constructor<ExitCode>;
  */
 export type ProcessId = Brand.Branded<number, "ProcessId">;
 /**
- * Brand constructor for child process `ProcessId` values.
+ * Constructs branded child process `ProcessId` values.
  *
  * @category constructors
  * @since 4.0.0

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

@@ -1 +1 @@
-{"version":3,"file":"ChildProcessSpawner.d.ts","sourceRoot":"","sources":["../../../src/unstable/process/ChildProcessSpawner.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,KAAK,aAAa,MAAM,wBAAwB,CAAA;AAC5D,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,KAAK,IAAI,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAExD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAA6B,CAAA;AAE9E;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,SAAS,CAA8B,CAAA;AAEjF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;AAEpE,QAAA,MAAM,YAAY,mDAAmD,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,OAAO,YAAY,CAAA;IAC5C;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACtG;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IAC/E;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACpE;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACpG;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;CAClE;AAUD;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,IAAI,CAAC,kBAAkB,EAAE,OAAO,YAAY,CAAC,KAAG,kBAChC,CAAA;AAEnD;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,GAAI,OAAO,mBAAmB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAG,mBAAmB,CAAC,SAAS,CAqBlG,CAAA;;IASC;;OAEG;mBAEQ,OAAO,GACf,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,aAAa,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC;IAE9E;;OAEG;sBAEQ,OAAO,GACf,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC;IAEvD;;;OAGG;0BACmB,OAAO,YAAY;QACvC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;IAEtD;;;OAGG;yBACkB,OAAO,YAAY;QACtC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;IAEtD;;OAEG;mBACY,OAAO,YAAY;QAChC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC;IAE7D;;OAEG;oBACa,OAAO,YAAY;QACjC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;;AAjDxD;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,wBA4CC;CAAG"}
+{"version":3,"file":"ChildProcessSpawner.d.ts","sourceRoot":"","sources":["../../../src/unstable/process/ChildProcessSpawner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,KAAK,aAAa,MAAM,wBAAwB,CAAA;AAC5D,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,KAAK,IAAI,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAExD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAA6B,CAAA;AAE9E;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,SAAS,CAA8B,CAAA;AAEjF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;AAEpE,QAAA,MAAM,YAAY,mDAAmD,CAAA;AAErE;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,OAAO,YAAY,CAAA;IAC5C;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACtG;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IAC/E;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACvE;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACpE;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IACpG;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;CAClE;AAUD;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,IAAI,CAAC,kBAAkB,EAAE,OAAO,YAAY,CAAC,KAAG,kBAChC,CAAA;AAEnD;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,GAAI,OAAO,mBAAmB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAG,mBAAmB,CAAC,SAAS,CAqBlG,CAAA;;IASC;;OAEG;mBAEQ,OAAO,GACf,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,aAAa,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC;IAE9E;;OAEG;sBAEQ,OAAO,GACf,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,aAAa,CAAC;IAEvD;;;OAGG;0BACmB,OAAO,YAAY;QACvC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;IAEtD;;;OAGG;yBACkB,OAAO,YAAY;QACtC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;IAEtD;;OAEG;mBACY,OAAO,YAAY;QAChC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC;IAE7D;;OAEG;oBACa,OAAO,YAAY;QACjC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC7C,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;;AAjDxD;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,wBA4CC;CAAG"}

package/dist/unstable/process/ChildProcessSpawner.js

@@ -1,8 +1,20 @@
 /**
- * A module providing a generic service interface for spawning child processes.
+ * Service contract and helpers for running child processes through Effect.
  *
- * This module provides the `ChildProcessSpawner` service tag which can be
- * implemented by platform-specific packages (e.g., Node.js).
+ * This module defines the {@link ChildProcessSpawner} service used by child
+ * process commands to start operating-system processes. A spawner turns a
+ * command description into a {@link ChildProcessHandle}, which exposes scoped
+ * lifecycle operations: write to stdin, stream stdout and stderr, wait for the
+ * exit code, kill the process, inspect whether it is still running, and
+ * temporarily unreference it from the parent process.
+ *
+ * Use this module when implementing a platform-specific process backend or
+ * when code needs direct access to the process service. Most applications build
+ * commands with the `ChildProcess` module; this service is the lower-level
+ * execution boundary and also provides convenience methods for collecting exit
+ * codes, strings, and output lines. The {@link make} constructor derives those
+ * helpers from one primitive `spawn` implementation, so adapters only need to
+ * supply process creation.
  *
  * @since 4.0.0
  */
@@ -12,14 +24,14 @@ import * as Effect from "../../Effect.js";
 import * as Inspectable from "../../Inspectable.js";
 import * as Stream from "../../Stream.js";
 /**
- * Brand constructor for child process `ExitCode` values.
+ * Constructs branded child process `ExitCode` values.
  *
  * @category constructors
  * @since 4.0.0
  */
 export const ExitCode = /*#__PURE__*/Brand.nominal();
 /**
- * Brand constructor for child process `ProcessId` values.
+ * Constructs branded child process `ProcessId` values.
  *
  * @category constructors
  * @since 4.0.0