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

package/src/unstable/persistence/index.ts

@@ -5,183 +5,36 @@
 // @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.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/src/unstable/process/ChildProcess.ts

@@ -534,7 +534,7 @@ const Proto = {
 }
 
 /**
- * Check if a value is a `Command`.
+ * Checks whether a value is a `Command`.
  *
  * @category guards
  * @since 4.0.0
@@ -542,7 +542,7 @@ const Proto = {
 export const isCommand = (u: unknown): u is Command => Predicate.hasProperty(u, TypeId)
 
 /**
- * Check if a command is a `StandardCommand`.
+ * Checks whether a command is a `StandardCommand`.
  *
  * @category guards
  * @since 4.0.0
@@ -550,7 +550,7 @@ export const isCommand = (u: unknown): u is Command => Predicate.hasProperty(u,
 export const isStandardCommand = (command: Command): command is StandardCommand => command._tag === "StandardCommand"
 
 /**
- * Check if a command is a `PipedCommand`.
+ * Checks whether a command is a `PipedCommand`.
  *
  * @category guards
  * @since 4.0.0
@@ -783,7 +783,7 @@ export const make: {
 }
 
 /**
- * Pipe the output of one command to the input of another.
+ * Pipes the output of one command to the input of another.
  *
  * **Details**
  *
@@ -816,7 +816,7 @@ export const make: {
  */
 export 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**
    *
@@ -849,7 +849,7 @@ export 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**
    *
@@ -887,7 +887,7 @@ export const pipeTo: {
 )
 
 /**
- * Prefix a command with another command.
+ * Prepends another command to a command.
  *
  * **Details**
  *
@@ -912,7 +912,7 @@ export const pipeTo: {
  */
 export const prefix: {
   /**
-   * Prefix a command with another command.
+   * Prepends another command to a command.
    *
    * **Details**
    *
@@ -937,7 +937,7 @@ export const prefix: {
    */
   (command: string, args?: ReadonlyArray<string>): (self: Command) => Command
   /**
-   * Prefix a command with another command.
+   * Prepends another command to a command.
    *
    * **Details**
    *
@@ -965,7 +965,7 @@ export const prefix: {
     ...expressions: ReadonlyArray<TemplateExpression>
   ): (self: Command) => Command
   /**
-   * Prefix a command with another command.
+   * Prepends another command to a command.
    *
    * **Details**
    *
@@ -1030,7 +1030,7 @@ const applyPrefix = (self: Command, prefixSpec: PrefixSpec): Command => {
 }
 
 /**
- * Set the current working directory for a command.
+ * Sets the current working directory for a command.
  *
  * **Details**
  *
@@ -1051,7 +1051,7 @@ const applyPrefix = (self: Command, prefixSpec: PrefixSpec): Command => {
  */
 export const setCwd: {
   /**
-   * Set the current working directory for a command.
+   * Sets the current working directory for a command.
    *
    * **Details**
    *
@@ -1072,7 +1072,7 @@ export const setCwd: {
    */
   (cwd: string): (self: Command) => Command
   /**
-   * Set the current working directory for a command.
+   * Sets the current working directory for a command.
    *
    * **Details**
    *
@@ -1197,7 +1197,7 @@ const isTemplateString = (u: unknown): u is TemplateStringsArray =>
 // =============================================================================
 
 /**
- * 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/src/unstable/process/ChildProcessSpawner.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
  */
@@ -25,7 +37,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
@@ -42,7 +54,7 @@ export const ExitCode: Brand.Constructor<ExitCode> = Brand.nominal<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/src/unstable/process/index.ts

@@ -5,56 +5,11 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
- * An Effect-native module for working with child processes.
- *
- * This module uses an AST-based approach where commands are built first
- * using `make` and `pipeTo`, then executed using `spawn`.
- *
- * **Example** (Spawning and piping commands)
- *
- * ```ts
- * import { Effect, Stream } from "effect"
- * import { NodeServices } from "@effect/platform-node"
- * import { ChildProcess } from "effect/unstable/process"
- *
- * // Build a command
- * const command = ChildProcess.make`echo "hello world"`
- *
- * // Spawn and collect output
- * const program = Effect.gen(function*() {
- *   // You can `yield*` a command, which calls `ChildProcess.spawn`
- *   const handle = yield* command
- *   const chunks = yield* Stream.runCollect(handle.stdout)
- *   const exitCode = yield* handle.exitCode
- *   return { chunks, exitCode }
- * }).pipe(Effect.scoped, Effect.provide(NodeServices.layer))
- *
- * // With options
- * const withOptions = ChildProcess.make({ cwd: "/tmp" })`ls -la`
- *
- * // Piping commands
- * const pipeline = ChildProcess.make`cat package.json`.pipe(
- *   ChildProcess.pipeTo(ChildProcess.make`grep name`)
- * )
- *
- * // Spawn the pipeline
- * const pipelineProgram = Effect.gen(function*() {
- *   const handle = yield* pipeline
- *   const chunks = yield* Stream.runCollect(handle.stdout)
- *   return chunks
- * }).pipe(Effect.scoped, Effect.provide(NodeServices.layer))
- * ```
- *
  * @since 4.0.0
  */
 export * as ChildProcess from "./ChildProcess.ts"
 
 /**
- * A module providing a generic service interface for spawning child processes.
- *
- * This module provides the `ChildProcessSpawner` service tag which can be
- * implemented by platform-specific packages (e.g., Node.js).
- *
  * @since 4.0.0
  */
 export * as ChildProcessSpawner from "./ChildProcessSpawner.ts"

package/src/unstable/reactivity/AsyncResult.ts

@@ -1,23 +1,44 @@
 /**
- * The `AsyncResult` module models the state of an asynchronous value inside the
- * reactivity APIs. It represents whether a computation has not produced a
- * result yet, has succeeded, or has failed, while keeping `waiting` as a
- * separate flag for first loads, refreshes, retries, and other in-flight work.
+ * State containers for asynchronous values used by the reactivity APIs.
  *
- * This is useful for atoms and UI integrations that need to render async
- * queries, background refreshes, optimistic transitions, stream pulls, or RPC
- * and HTTP calls without losing track of the current value. `Success` contains
- * the latest value and timestamp, and `Failure` contains a `Cause` plus an
- * optional `previousSuccess` so callers can keep showing stale data after a
- * refresh fails.
+ * `AsyncResult` records the latest observable state of work that may still be
+ * loading, refreshing, retrying, or recovering from failure. The value is one of
+ * `Initial`, `Success`, or `Failure`, and every variant also carries a `waiting`
+ * flag so callers can keep rendering the current state while newer work is in
+ * flight.
  *
- * Treat `waiting` as an overlay rather than a fourth state: an `Initial` result
- * can be waiting with no value, and a `Success` or `Failure` can also be waiting
- * while a newer computation is running. Accessors such as `value` and
- * `getOrElse` may return the previous success stored in a failure, so inspect
- * `cause` or `error` when the difference between a current success and stale
- * data matters. Matchers such as `matchWithWaiting` prioritize the waiting flag,
- * while `match` and `matchWithError` expose the underlying state.
+ * **Mental model**
+ *
+ * The variant answers "what do we know right now?", while `waiting` answers "is
+ * newer work currently running?". A success contains the current value and its
+ * timestamp. A failure contains a `Cause` and may also keep the previous
+ * success, which lets UI and atom code show stale data while exposing the latest
+ * failure for error displays and retry logic.
+ *
+ * **Common tasks**
+ *
+ * - Start with {@link initial}, {@link success}, {@link failure}, or
+ *   {@link fail}
+ * - Convert Effect exits with {@link fromExit} and
+ *   {@link fromExitWithPrevious}
+ * - Mark existing state as loading with {@link waiting} or
+ *   {@link waitingFrom}
+ * - Read values and failures with {@link value}, {@link cause}, {@link error},
+ *   {@link getOrElse}, and {@link toExit}
+ * - Transform and combine results with {@link map}, {@link flatMap}, and
+ *   {@link all}
+ * - Render all states with {@link match}, {@link matchWithWaiting}, or
+ *   {@link builder}
+ *
+ * **Gotchas**
+ *
+ * - `waiting` is an overlay, not a fourth variant; any variant can be waiting.
+ * - {@link value} and {@link getOrElse} can read the previous success stored in
+ *   a failure, so inspect {@link cause} or {@link error} when stale data and a
+ *   current success must be distinguished.
+ * - {@link matchWithWaiting} handles waiting before variant-specific branches,
+ *   while {@link match} and {@link matchWithError} expose the underlying
+ *   variant first.
  *
  * @since 4.0.0
  */
@@ -401,9 +422,10 @@ export const touch = <A extends AsyncResult<any, any>>(result: A): A => {
 }
 
 /**
- * For a `Failure`, replaces its stored previous success with the latest success found in another result; non-failures are returned unchanged.
+ * Replaces a `Failure` value's stored previous success with the latest success
+ * found in another result.
  *
- * @category constructors
+ * @category combinators
  * @since 4.0.0
  */
 export const replacePrevious = <R extends AsyncResult<any, any>, XE, A>(
@@ -539,21 +561,51 @@ export const map: {
 })
 
 /**
- * Flat maps a success result with a function returning another `AsyncResult`, leaves initial results unchanged, and preserves failure causes while remapping stored previous successes when possible.
+ * Maps the success value of an `AsyncResult` and flattens the result.
+ *
+ * **When to use**
+ *
+ * Use to sequence computations that may return another `AsyncResult` while
+ * preserving initial and failure states.
+ *
+ * **Details**
+ *
+ * Initial results are left unchanged. Failures preserve their cause and remap
+ * the stored previous success when the mapping function returns a success.
  *
  * @category combinators
  * @since 4.0.0
  */
 export const flatMap: {
   /**
-   * Flat maps a success result with a function returning another `AsyncResult`, leaves initial results unchanged, and preserves failure causes while remapping stored previous successes when possible.
+   * Maps the success value of an `AsyncResult` and flattens the result.
+   *
+   * **When to use**
+   *
+   * Use to sequence computations that may return another `AsyncResult` while
+   * preserving initial and failure states.
+   *
+   * **Details**
+   *
+   * Initial results are left unchanged. Failures preserve their cause and remap
+   * the stored previous success when the mapping function returns a success.
    *
    * @category combinators
    * @since 4.0.0
    */
   <A, E, B, E2>(f: (a: A, prev: Success<A, E>) => AsyncResult<A, E2>): (self: AsyncResult<A, E>) => AsyncResult<B, E | E2>
   /**
-   * Flat maps a success result with a function returning another `AsyncResult`, leaves initial results unchanged, and preserves failure causes while remapping stored previous successes when possible.
+   * Maps the success value of an `AsyncResult` and flattens the result.
+   *
+   * **When to use**
+   *
+   * Use to sequence computations that may return another `AsyncResult` while
+   * preserving initial and failure states.
+   *
+   * **Details**
+   *
+   * Initial results are left unchanged. Failures preserve their cause and remap
+   * the stored previous success when the mapping function returns a success.
    *
    * @category combinators
    * @since 4.0.0
@@ -573,13 +625,33 @@ export const flatMap: {
         return self as any as AsyncResult<B, E>
       case "Failure":
         return failure</**
-         * Flat maps a success result with a function returning another `AsyncResult`, leaves initial results unchanged, and preserves failure causes while remapping stored previous successes when possible.
+         * Maps the success value of an `AsyncResult` and flattens the result.
+         *
+         * **When to use**
+         *
+         * Use to sequence computations that may return another `AsyncResult` while
+         * preserving initial and failure states.
+         *
+         * **Details**
+         *
+         * Initial results are left unchanged. Failures preserve their cause and remap
+         * the stored previous success when the mapping function returns a success.
          *
          * @category combinators
          * @since 4.0.0
          */
         B, /**
-         * Flat maps a success result with a function returning another `AsyncResult`, leaves initial results unchanged, and preserves failure causes while remapping stored previous successes when possible.
+         * Maps the success value of an `AsyncResult` and flattens the result.
+         *
+         * **When to use**
+         *
+         * Use to sequence computations that may return another `AsyncResult` while
+         * preserving initial and failure states.
+         *
+         * **Details**
+         *
+         * Initial results are left unchanged. Failures preserve their cause and remap
+         * the stored previous success when the mapping function returns a success.
          *
          * @category combinators
          * @since 4.0.0