effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/unstable/sql/index.js

@@ -3,39 +3,217 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * Effect SQL migration helpers for loading, ordering, and running schema
+ * changes against a `SqlClient`.
+ *
+ * This module provides a migrator constructor plus loaders for common migration
+ * layouts, including dynamic glob imports, Babel-style glob records, in-memory
+ * records, and filesystem directories. It is intended for applications and
+ * libraries that need to apply numbered SQL migrations on startup, in tests, or
+ * as part of deployment tooling while keeping migration effects inside the
+ * Effect environment.
+ *
+ * The migrator tracks applied migrations in a configurable table, defaults that
+ * table to `effect_sql_migrations`, rejects duplicate migration ids, and only
+ * runs migrations with an id greater than the latest recorded id. Pending
+ * migrations are recorded and executed inside a `SqlClient` transaction; on
+ * PostgreSQL the migrations table is explicitly locked, while other dialects
+ * rely on the table's primary key or unique constraint to detect concurrent
+ * runners. Migration effects should therefore be written to be transaction-aware,
+ * and callers should account for dialect-specific DDL transaction behavior and
+ * custom table names when coordinating schema dumps or external migration
+ * tooling.
+ *
  * @since 4.0.0
  */
 export * as Migrator from "./Migrator.js";
 /**
+ * Defines the `SqlClient` service, the central runtime entry point for Effect's
+ * unstable SQL support.
+ *
+ * A `SqlClient` combines the tagged-template statement constructor with a
+ * scoped connection acquirer, dialect compiler, tracing attributes, optional row
+ * transforms, reactive query helpers, and transaction management. Applications
+ * typically consume it from `Context` to build parameterized queries, stream
+ * rows, run raw driver operations, reserve a connection for lower-level work, or
+ * wrap several query effects in `withTransaction`.
+ *
+ * Transactions are tracked through a per-client context service. Top-level
+ * transactions acquire the configured transaction connection and issue the
+ * dialect's begin/commit/rollback SQL; nested transactions reuse that
+ * connection and rely on dialect-provided savepoint SQL. A query only joins a
+ * transaction when it is run with the same client service, so avoid mixing
+ * clients or manually reserved connections when atomicity matters. Dialect
+ * integrations are also responsible for the compiler and transaction
+ * statements, which means placeholder syntax, identifier escaping, row
+ * transforms, savepoint support, and unprepared/raw statement behavior can
+ * differ by database.
+ *
  * @since 4.0.0
  */
 export * as SqlClient from "./SqlClient.js";
 /**
+ * Defines the low-level SQL connection service and shared row/acquirer types
+ * used by Effect's unstable SQL driver integrations.
+ *
+ * A `Connection` is the driver-facing layer underneath `SqlClient`: it executes
+ * already-compiled SQL with positional parameters and exposes transformed row
+ * results, raw driver results, streams, value arrays, and unprepared statement
+ * execution. Most applications should work through `SqlClient`, while driver
+ * integrations and advanced code use this module to provide scoped connection
+ * acquisition, implement pooling, reserve a connection for a workflow, or adapt
+ * a dialect-specific client into Effect.
+ *
+ * Connections are resources and should be acquired through an `Acquirer` in a
+ * `Scope` so pool checkout, transaction pinning, and release semantics are
+ * preserved. Transaction coordination lives at the `SqlClient` layer, so mixing
+ * manually reserved connections with transactional client queries can bypass the
+ * expected atomic boundary. Raw, unprepared, streaming, parameter, and row
+ * transformation behavior ultimately comes from the driver and dialect; check
+ * each integration for differences in placeholders, prepared statement support,
+ * cursor lifetime, and result shapes.
+ *
  * @since 4.0.0
  */
 export * as SqlConnection from "./SqlConnection.js";
 /**
+ * Structured SQL errors used by the unstable SQL APIs.
+ *
+ * This module defines the top-level `SqlError` wrapper, the concrete
+ * `SqlErrorReason` variants used by drivers and adapters, and helpers for
+ * recognizing and classifying database failures. It is useful when turning
+ * native driver errors into typed Effect failures, choosing retry policies from
+ * `isRetryable`, or distinguishing user-facing query problems such as syntax
+ * and constraint failures from infrastructure problems such as connection,
+ * lock, statement timeout, deadlock, and serialization failures.
+ *
+ * Query, connection, and migration code should preserve the original cause and
+ * operation metadata when constructing these errors. Retrying can be appropriate
+ * for transient connection and concurrency failures, but syntax, authorization,
+ * authentication, and constraint failures generally require changing the query,
+ * credentials, permissions, or migration data. When classifying SQLite errors,
+ * the helpers inspect `code` and `errno` values and extract unique constraint
+ * names when available.
+ *
  * @since 4.0.0
  */
 export * as SqlError from "./SqlError.js";
 /**
- * @since 4.0.0
+ * Builds SQL repositories and request resolvers from Effect schema models.
+ *
+ * Use this module when a `Model` describes rows in a concrete SQL table and
+ * you want the common insert, update, find-by-id, and delete operations without
+ * hand-writing the schema encoding, row decoding, and resolver batching each
+ * time. The helpers are intended for model-backed tables where the model field
+ * names line up with the encoded table columns and the chosen `idColumn` is
+ * present in both the model fields and update schema.
+ *
+ * Returned rows are decoded with the full model schema, while insert and update
+ * requests are encoded with the model's dedicated input schemas. Soft deletes
+ * are opt-in via `softDeleteColumn`: reads and updates only see rows where that
+ * column is `null`, and deletes set it to `CURRENT_TIMESTAMP` instead of
+ * removing the row. Dialects with `returning` support return changed rows
+ * directly; MySQL performs a follow-up `select`, so generated ids, defaults,
+ * and trigger-updated values must be observable from that query.
+ *
  * @category models
+ * @since 4.0.0
  */
 export * as SqlModel from "./SqlModel.js";
 /**
+ * Schema-aware `RequestResolver` helpers for SQL-backed data loading.
+ *
+ * This module bridges `Effect.request` with `SqlClient` by representing each
+ * lookup or mutation as a `SqlRequest` and batching concurrent requests into a
+ * single SQL operation. Request payloads are encoded with the request schema
+ * before `execute` is called, and rows returned by the query are decoded with
+ * the result schema before entries are completed.
+ *
+ * Use `ordered` when a query returns exactly one row per request in the same
+ * order, `findById` for `where id in (...)` lookups, `grouped` for one-to-many
+ * relationships, and `void` for inserts, updates, deletes, or other
+ * side-effecting statements where no row is needed.
+ *
+ * **Gotchas**
+ *
+ * - `ordered` requires the result count and order to match the request batch.
+ * - `grouped` and `findById` rely on stable request/result keys and fail
+ *   missing requests with `NoSuchElementError`.
+ * - Equal payloads are equal `SqlRequest`s, which enables request batching,
+ *   deduplication, and cache reuse; model payload identity deliberately.
+ * - Batches are split by the active SQL transaction connection, so requests
+ *   made in different transactions are not resolved together.
+ * - Queries like `where id in (...)` often return rows in database order; use
+ *   `findById` or `grouped`, or preserve input order explicitly before choosing
+ *   `ordered`.
+ *
  * @since 4.0.0
  */
 export * as SqlResolver from "./SqlResolver.js";
 /**
+ * Schema-driven helpers for wrapping SQL executions in typed query functions.
+ *
+ * This module connects `Schema` request and result definitions to an `execute`
+ * callback that runs the actual SQL statement. The returned functions accept
+ * the request schema's decoded `Type`, encode it to the SQL-facing `Encoded`
+ * shape, run the callback, and then decode unknown driver rows through the
+ * result schema. This is useful for repository methods, CRUD helpers, request
+ * resolvers, and write operations where callers should work with domain values
+ * instead of raw SQL parameters or rows.
+ *
+ * The `execute` callback always receives `Req["Encoded"]`, so schema
+ * transformations, required encoding services, and database representations
+ * such as nullable columns, JSON values, dates, and bigints must line up with
+ * the statement builder and dialect in use. Result schemas decode the rows
+ * returned by the driver after any SQL client row transforms; `findOne` and
+ * `findOneOption` only inspect the first row, `findNonEmpty` requires at least
+ * one row, and `void` discards any driver result after request encoding.
+ *
  * @since 4.0.0
  */
 export * as SqlSchema from "./SqlSchema.js";
 /**
+ * Low-level helpers for adapting push-based SQL row sources into Effect
+ * streams.
+ *
+ * SQL drivers often expose large query results through cursors, event emitters,
+ * or driver-specific streams that push rows as they arrive. This module
+ * provides the small interop layer used by SQL integrations to turn those
+ * producers into `Stream` values for `Statement.stream` and
+ * `Connection.executeStream`, so callers can process large result sets
+ * incrementally instead of materializing every row in memory.
+ *
+ * The adapter is scoped: driver cursors, query streams, or reserved
+ * connections should be acquired in the registration effect and released with
+ * finalizers. The internal queue is bounded and calls the producer's
+ * `onPause`/`onResume` hooks when downstream consumption falls behind, but the
+ * underlying driver still has to honor those hooks for backpressure to be
+ * effective. Slow consumers may keep a database cursor and connection open for
+ * the lifetime of the stream, so integrations should close or destroy driver
+ * resources on interruption, failure, or normal completion and should signal
+ * terminal events with `fail` or `end` exactly once.
+ *
  * @since 4.0.0
  */
 export * as SqlStream from "./SqlStream.js";
 /**
+ * Building blocks for Effect's unstable SQL statement API.
+ *
+ * This module defines the low-level `Statement` and `Fragment` model used by
+ * SQL clients, the tagged-template `Constructor` for creating executable
+ * parameterized statements, and dialect compilers that turn statement segments
+ * into SQL text plus bind parameters. It also provides helpers for escaped
+ * identifiers, `IN` lists, comma-separated clause fragments, record inserts and
+ * updates, custom segments, and row or identifier transforms.
+ *
+ * In tagged templates, interpolated `Fragment`s and known `Segment`s are
+ * spliced into the statement, while ordinary values become bound parameters. Use
+ * identifiers for table and column names and the record helpers for generated
+ * column lists; `literal` and `unsafe` insert SQL text directly and should only
+ * be used with trusted SQL. Compilation is dialect-specific, caches rendered SQL
+ * on the statement, and has a `withoutTransform` path for bypassing identifier
+ * transforms, so compiled output can differ from normal transformed execution.
+ *
  * @since 4.0.0
  */
 export * as Statement from "./Statement.js";

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Migrator","SqlClient","SqlConnection","SqlError","SqlModel","SqlResolver","SqlSchema","SqlStream","Statement"],"sources":["../../../src/unstable/sql/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;;AAIA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Migrator","SqlClient","SqlConnection","SqlError","SqlModel","SqlResolver","SqlSchema","SqlStream","Statement"],"sources":["../../../src/unstable/sql/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKC,SAAS,MAAM,gBAAgB","ignoreList":[]}

package/dist/unstable/workers/Transferable.d.ts

@@ -1,5 +1,21 @@
 /**
- * @since 1.0.0
+ * Utilities for marking the parts of worker messages that should be transferred
+ * through `postMessage` instead of copied by the structured clone algorithm.
+ *
+ * This module is used with worker message schemas to collect
+ * `globalThis.Transferable` values while encoding a message, so the worker
+ * platform can pass the collected list as the `postMessage` transfer list.
+ * Common cases include sending large `Uint8Array` payloads, `ImageData` pixel
+ * buffers, or `MessagePort` channels without paying for an extra copy.
+ *
+ * Transferable annotations do not make an otherwise unsupported value
+ * structured-cloneable; the encoded message still has to be valid for
+ * `postMessage`. Transferring also moves ownership to the receiver, so buffers
+ * are detached from the sender after the send completes. Be careful when a
+ * typed array view shares a backing buffer with other data, since collecting
+ * that buffer transfers ownership of the whole buffer.
+ *
+ * @since 4.0.0
  */
 import * as Context from "../../Context.ts";
 import * as Effect from "../../Effect.ts";
@@ -14,66 +30,102 @@ declare const Collector_base: Context.ServiceClass<Collector, "effect/workers/Tr
     readonly clear: Effect.Effect<Array<globalThis.Transferable>>;
 }>;
 /**
- * @since 1.0.0
+ * Service for collecting `Transferable` objects while encoding worker messages
+ * so they can be passed to `postMessage` transfer lists.
+ *
  * @category models
+ * @since 4.0.0
  */
 export declare class Collector extends Collector_base {
 }
 /**
- * @since 1.0.0
+ * Creates a mutable `Collector` service directly, exposing unsafe synchronous
+ * methods for reading, adding, and clearing collected transferables.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const makeCollectorUnsafe: () => Collector["Service"];
 /**
- * @since 1.0.0
+ * Effect that creates a fresh `Collector` service for accumulating
+ * transferables.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const makeCollector: Effect.Effect<Collector["Service"]>;
 /**
- * @since 1.0.0
+ * Adds transferables to the current `Collector` when one is present in the
+ * context, and does nothing otherwise.
+ *
  * @category accessors
+ * @since 4.0.0
  */
 export declare const addAll: (tranferables: Iterable<globalThis.Transferable>) => Effect.Effect<void>;
 /**
- * @since 1.0.0
+ * Creates a schema getter that records transferables derived from a value in
+ * the current `Collector` while passing the value through unchanged.
+ *
  * @category Getter
+ * @since 4.0.0
  */
 export declare const getterAddAll: <A>(f: (_: A) => Iterable<globalThis.Transferable>) => Getter.Getter<A, A>;
 /**
- * @since 1.0.0
- * @category schema
+ * Schema wrapper whose encode path can record transferables with a `Collector`
+ * while preserving the wrapped schema's decoded type.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export interface Transferable<S extends Schema.Top> extends Schema.decodeTo<Schema.toType<S["Rebuild"]>, S["Rebuild"]> {
 }
 /**
- * @since 1.0.0
- * @category schema
+ * Wraps a schema so encoding records transferables selected from the encoded
+ * value, enabling worker messages to populate a `postMessage` transfer list.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const schema: {
     /**
-     * @since 1.0.0
-     * @category schema
+     * Wraps a schema so encoding records transferables selected from the encoded
+     * value, enabling worker messages to populate a `postMessage` transfer list.
+     *
+     * @category schemas
+     * @since 4.0.0
      */
     <S extends Schema.Top>(f: (_: S["Encoded"]) => Iterable<globalThis.Transferable>): (self: S) => Transferable<S>;
     /**
-     * @since 1.0.0
-     * @category schema
+     * Wraps a schema so encoding records transferables selected from the encoded
+     * value, enabling worker messages to populate a `postMessage` transfer list.
+     *
+     * @category schemas
+     * @since 4.0.0
      */
     <S extends Schema.Top>(self: S, f: (_: S["Encoded"]) => Iterable<globalThis.Transferable>): Transferable<S>;
 };
 /**
- * @since 1.0.0
- * @category schema
+ * Transferable schema for `ImageData` values that records the underlying pixel
+ * data buffer.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const ImageData: Transferable<Schema.declare<ImageData>>;
 /**
- * @since 1.0.0
- * @category schema
+ * Transferable schema for `MessagePort` values that records the port itself as
+ * transferable.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const MessagePort: Transferable<Schema.declare<MessagePort>>;
 /**
- * @since 1.0.0
- * @category schema
+ * Transferable schema for `Uint8Array` values that records the array's backing
+ * buffer.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const Uint8Array: Transferable<Schema.instanceOf<globalThis.Uint8Array<ArrayBuffer>>>;
 export {};

package/dist/unstable/workers/Transferable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Transferable.d.ts","sourceRoot":"","sources":["../../../src/unstable/workers/Transferable.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAA;;qBAO5B,CACf,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;2BACD,CAAC,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,IAAI;mBACtD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;yBACvC,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC;0BACnC,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC;oBAC1C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;;AAZ/D;;;GAGG;AACH,qBAAa,SAAU,SAAQ,cASc;CAAG;AAEhD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAO,SAAS,CAAC,SAAS,CAmBzD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAoC,CAAA;AAElG;;;GAGG;AACH,eAAO,MAAM,MAAM,GACjB,cAAc,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KAC9C,MAAM,CAAC,MAAM,CAAC,IAAI,CAMjB,CAAA;AAEJ;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAQlB,CAAA;AAEH;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,CAAE,SAClD,MAAM,CAAC,QAAQ,CACb,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAC3B,CAAC,CAAC,SAAS,CAAC,CACb;CACD;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;OAGG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,CAAA;IAC/G;;;OAGG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;CAe5G,CAAA;AAOD;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAG7D,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAGjE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAG1F,CAAA"}
+{"version":3,"file":"Transferable.d.ts","sourceRoot":"","sources":["../../../src/unstable/workers/Transferable.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAA;;qBAU5B,CACf,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;2BACD,CAAC,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,IAAI;mBACtD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;yBACvC,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC;0BACnC,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC;oBAC1C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;;AAf/D;;;;;;GAMG;AACH,qBAAa,SAAU,SAAQ,cASc;CAAG;AAEhD;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,QAAO,SAAS,CAAC,SAAS,CAmBzD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAoC,CAAA;AAElG;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GACjB,cAAc,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KAC9C,MAAM,CAAC,MAAM,CAAC,IAAI,CAMjB,CAAA;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,KAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAQlB,CAAA;AAEH;;;;;;GAMG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,CAAE,SAClD,MAAM,CAAC,QAAQ,CACb,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAC3B,CAAC,CAAC,SAAS,CAAC,CACb;CACD;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;OAMG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,CAAA;IAC/G;;;;;;OAMG;IACH,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;CAe5G,CAAA;AAOD;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAG7D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAGjE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAG1F,CAAA"}

package/dist/unstable/workers/Transferable.js

@@ -1,5 +1,21 @@
 /**
- * @since 1.0.0
+ * Utilities for marking the parts of worker messages that should be transferred
+ * through `postMessage` instead of copied by the structured clone algorithm.
+ *
+ * This module is used with worker message schemas to collect
+ * `globalThis.Transferable` values while encoding a message, so the worker
+ * platform can pass the collected list as the `postMessage` transfer list.
+ * Common cases include sending large `Uint8Array` payloads, `ImageData` pixel
+ * buffers, or `MessagePort` channels without paying for an extra copy.
+ *
+ * Transferable annotations do not make an otherwise unsupported value
+ * structured-cloneable; the encoded message still has to be valid for
+ * `postMessage`. Transferring also moves ownership to the receiver, so buffers
+ * are detached from the sender after the send completes. Be careful when a
+ * typed array view shares a backing buffer with other data, since collecting
+ * that buffer transfers ownership of the whole buffer.
+ *
+ * @since 4.0.0
  */
 import * as Context from "../../Context.js";
 import * as Effect from "../../Effect.js";
@@ -7,13 +23,19 @@ import { dual } from "../../Function.js";
 import * as Schema from "../../Schema.js";
 import * as Getter from "../../SchemaGetter.js";
 /**
- * @since 1.0.0
+ * Service for collecting `Transferable` objects while encoding worker messages
+ * so they can be passed to `postMessage` transfer lists.
+ *
  * @category models
+ * @since 4.0.0
  */
 export class Collector extends /*#__PURE__*/Context.Service()("effect/workers/Transferable/Collector") {}
 /**
- * @since 1.0.0
+ * Creates a mutable `Collector` service directly, exposing unsafe synchronous
+ * methods for reading, adding, and clearing collected transferables.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const makeCollectorUnsafe = () => {
   let tranferables = [];
@@ -36,13 +58,19 @@ export const makeCollectorUnsafe = () => {
   });
 };
 /**
- * @since 1.0.0
+ * Effect that creates a fresh `Collector` service for accumulating
+ * transferables.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const makeCollector = /*#__PURE__*/Effect.sync(makeCollectorUnsafe);
 /**
- * @since 1.0.0
+ * Adds transferables to the current `Collector` when one is present in the
+ * context, and does nothing otherwise.
+ *
  * @category accessors
+ * @since 4.0.0
  */
 export const addAll = tranferables => Effect.contextWith(services => {
   const collector = Context.getOrUndefined(services, Collector);
@@ -51,8 +79,11 @@ export const addAll = tranferables => Effect.contextWith(services => {
   return Effect.void;
 });
 /**
- * @since 1.0.0
+ * Creates a schema getter that records transferables derived from a value in
+ * the current `Collector` while passing the value through unchanged.
+ *
  * @category Getter
+ * @since 4.0.0
  */
 export const getterAddAll = f => Getter.transformOrFail(e => Effect.contextWith(services => {
   const collector = Context.getOrUndefined(services, Collector);
@@ -61,8 +92,11 @@ export const getterAddAll = f => Getter.transformOrFail(e => Effect.contextWith(
   return Effect.succeed(e);
 }));
 /**
- * @since 1.0.0
- * @category schema
+ * Wraps a schema so encoding records transferables selected from the encoded
+ * value, enabling worker messages to populate a `postMessage` transfer list.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const schema = /*#__PURE__*/dual(2, (self, f) => self.annotate({
   toCodecJson: () => passthroughLink
@@ -75,18 +109,27 @@ const passthroughLink = /*#__PURE__*/Schema.link()(Schema.Any, {
   encode: /*#__PURE__*/Getter.passthrough()
 });
 /**
- * @since 1.0.0
- * @category schema
+ * Transferable schema for `ImageData` values that records the underlying pixel
+ * data buffer.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const ImageData = /*#__PURE__*/schema(Schema.Any, _ => [_.data.buffer]);
 /**
- * @since 1.0.0
- * @category schema
+ * Transferable schema for `MessagePort` values that records the port itself as
+ * transferable.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const MessagePort = /*#__PURE__*/schema(Schema.Any, _ => [_]);
 /**
- * @since 1.0.0
- * @category schema
+ * Transferable schema for `Uint8Array` values that records the array's backing
+ * buffer.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const Uint8Array = /*#__PURE__*/schema(Schema.Uint8Array, _ => [_.buffer]);
 //# sourceMappingURL=Transferable.js.map

package/dist/unstable/workers/Transferable.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transferable.js","names":["Context","Effect","dual","Schema","Getter","Collector","Service","makeCollectorUnsafe","tranferables","unsafeAddAll","transfers","push","unsafeRead","unsafeClear","prev","of","addAllUnsafe","addAll","transferables","sync","readUnsafe","read","clearUnsafe","clear","makeCollector","contextWith","services","collector","getOrUndefined","void","getterAddAll","f","transformOrFail","e","succeed","schema","self","annotate","toCodecJson","passthroughLink","pipe","decode","passthrough","encode","link","Any","ImageData","_","data","buffer","MessagePort","Uint8Array"],"sources":["../../../src/unstable/workers/Transferable.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,IAAI,QAAQ,mBAAmB;AACxC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C;;;;AAIA,OAAM,MAAOC,SAAU,sBAAQL,OAAO,CAACM,OAAO,EAS1C,CAAC,uCAAuC,CAAC;AAE7C;;;;AAIA,OAAO,MAAMC,mBAAmB,GAAGA,CAAA,KAA2B;EAC5D,IAAIC,YAAY,GAAmC,EAAE;EACrD,MAAMC,YAAY,GAAIC,SAA4C,IAAU;IAC1EF,YAAY,CAACG,IAAI,CAAC,GAAGD,SAAS,CAAC;EACjC,CAAC;EACD,MAAME,UAAU,GAAGA,CAAA,KAAsCJ,YAAY;EACrE,MAAMK,WAAW,GAAGA,CAAA,KAAqC;IACvD,MAAMC,IAAI,GAAGN,YAAY;IACzBA,YAAY,GAAG,EAAE;IACjB,OAAOM,IAAI;EACb,CAAC;EACD,OAAOT,SAAS,CAACU,EAAE,CAAC;IAClBC,YAAY,EAAEP,YAAY;IAC1BQ,MAAM,EAAGC,aAAa,IAAKjB,MAAM,CAACkB,IAAI,CAAC,MAAMV,YAAY,CAACS,aAAa,CAAC,CAAC;IACzEE,UAAU,EAAER,UAAU;IACtBS,IAAI,EAAEpB,MAAM,CAACkB,IAAI,CAACP,UAAU,CAAC;IAC7BU,WAAW,EAAET,WAAW;IACxBU,KAAK,EAAEtB,MAAM,CAACkB,IAAI,CAACN,WAAW;GAC/B,CAAC;AACJ,CAAC;AAED;;;;AAIA,OAAO,MAAMW,aAAa,gBAAwCvB,MAAM,CAACkB,IAAI,CAACZ,mBAAmB,CAAC;AAElG;;;;AAIA,OAAO,MAAMU,MAAM,GACjBT,YAA+C,IAE/CP,MAAM,CAACwB,WAAW,CAAEC,QAAQ,IAAI;EAC9B,MAAMC,SAAS,GAAG3B,OAAO,CAAC4B,cAAc,CAACF,QAAQ,EAAErB,SAAS,CAAC;EAC7D,IAAI,CAACsB,SAAS,EAAE,OAAO1B,MAAM,CAAC4B,IAAI;EAClCF,SAAS,CAACX,YAAY,CAACR,YAAY,CAAC;EACpC,OAAOP,MAAM,CAAC4B,IAAI;AACpB,CAAC,CAAC;AAEJ;;;;AAIA,OAAO,MAAMC,YAAY,GACvBC,CAA8C,IAE9C3B,MAAM,CAAC4B,eAAe,CAAEC,CAAI,IAC1BhC,MAAM,CAACwB,WAAW,CAAEC,QAAQ,IAAI;EAC9B,MAAMC,SAAS,GAAG3B,OAAO,CAAC4B,cAAc,CAACF,QAAQ,EAAErB,SAAS,CAAC;EAC7D,IAAI,CAACsB,SAAS,EAAE,OAAO1B,MAAM,CAACiC,OAAO,CAACD,CAAC,CAAC;EACxCN,SAAS,CAACX,YAAY,CAACe,CAAC,CAACE,CAAC,CAAC,CAAC;EAC5B,OAAOhC,MAAM,CAACiC,OAAO,CAACD,CAAC,CAAC;AAC1B,CAAC,CAAC,CACH;AAaH;;;;AAIA,OAAO,MAAME,MAAM,gBAWfjC,IAAI,CACN,CAAC,EACD,CACEkC,IAAO,EACPL,CAAyD,KAEzDK,IAAI,CAACC,QAAQ,CAAC;EACZC,WAAW,EAAEA,CAAA,KAAMC;CACpB,CAAC,CAACC,IAAI,CACLrC,MAAM,CAACsC,MAAM,CAAC;EACZA,MAAM,EAAErC,MAAM,CAACsC,WAAW,EAAE;EAC5BC,MAAM,EAAEb,YAAY,CAACC,CAAC;CACvB,CAAC,CACH,CACJ;AAED,MAAMQ,eAAe,gBAAGpC,MAAM,CAACyC,IAAI,EAAE,CAACzC,MAAM,CAAC0C,GAAG,EAAE;EAChDJ,MAAM,eAAErC,MAAM,CAACsC,WAAW,EAAE;EAC5BC,MAAM,eAAEvC,MAAM,CAACsC,WAAW;CAC3B,CAAC;AAEF;;;;AAIA,OAAO,MAAMI,SAAS,gBAA4CX,MAAM,CACtEhC,MAAM,CAAC0C,GAAkD,EACxDE,CAAC,IAAK,CAACA,CAAC,CAACC,IAAI,CAACC,MAAM,CAAC,CACvB;AAED;;;;AAIA,OAAO,MAAMC,WAAW,gBAA8Cf,MAAM,CAC1EhC,MAAM,CAAC0C,GAAyC,EAC/CE,CAAC,IAAK,CAACA,CAAC,CAAC,CACX;AAED;;;;AAIA,OAAO,MAAMI,UAAU,gBAAwEhB,MAAM,CACnGhC,MAAM,CAACgD,UAAiB,EACvBJ,CAAC,IAAK,CAACA,CAAC,CAACE,MAAM,CAAC,CAClB","ignoreList":[]}
+{"version":3,"file":"Transferable.js","names":["Context","Effect","dual","Schema","Getter","Collector","Service","makeCollectorUnsafe","tranferables","unsafeAddAll","transfers","push","unsafeRead","unsafeClear","prev","of","addAllUnsafe","addAll","transferables","sync","readUnsafe","read","clearUnsafe","clear","makeCollector","contextWith","services","collector","getOrUndefined","void","getterAddAll","f","transformOrFail","e","succeed","schema","self","annotate","toCodecJson","passthroughLink","pipe","decode","passthrough","encode","link","Any","ImageData","_","data","buffer","MessagePort","Uint8Array"],"sources":["../../../src/unstable/workers/Transferable.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,SAASC,IAAI,QAAQ,mBAAmB;AACxC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C;;;;;;;AAOA,OAAM,MAAOC,SAAU,sBAAQL,OAAO,CAACM,OAAO,EAS1C,CAAC,uCAAuC,CAAC;AAE7C;;;;;;;AAOA,OAAO,MAAMC,mBAAmB,GAAGA,CAAA,KAA2B;EAC5D,IAAIC,YAAY,GAAmC,EAAE;EACrD,MAAMC,YAAY,GAAIC,SAA4C,IAAU;IAC1EF,YAAY,CAACG,IAAI,CAAC,GAAGD,SAAS,CAAC;EACjC,CAAC;EACD,MAAME,UAAU,GAAGA,CAAA,KAAsCJ,YAAY;EACrE,MAAMK,WAAW,GAAGA,CAAA,KAAqC;IACvD,MAAMC,IAAI,GAAGN,YAAY;IACzBA,YAAY,GAAG,EAAE;IACjB,OAAOM,IAAI;EACb,CAAC;EACD,OAAOT,SAAS,CAACU,EAAE,CAAC;IAClBC,YAAY,EAAEP,YAAY;IAC1BQ,MAAM,EAAGC,aAAa,IAAKjB,MAAM,CAACkB,IAAI,CAAC,MAAMV,YAAY,CAACS,aAAa,CAAC,CAAC;IACzEE,UAAU,EAAER,UAAU;IACtBS,IAAI,EAAEpB,MAAM,CAACkB,IAAI,CAACP,UAAU,CAAC;IAC7BU,WAAW,EAAET,WAAW;IACxBU,KAAK,EAAEtB,MAAM,CAACkB,IAAI,CAACN,WAAW;GAC/B,CAAC;AACJ,CAAC;AAED;;;;;;;AAOA,OAAO,MAAMW,aAAa,gBAAwCvB,MAAM,CAACkB,IAAI,CAACZ,mBAAmB,CAAC;AAElG;;;;;;;AAOA,OAAO,MAAMU,MAAM,GACjBT,YAA+C,IAE/CP,MAAM,CAACwB,WAAW,CAAEC,QAAQ,IAAI;EAC9B,MAAMC,SAAS,GAAG3B,OAAO,CAAC4B,cAAc,CAACF,QAAQ,EAAErB,SAAS,CAAC;EAC7D,IAAI,CAACsB,SAAS,EAAE,OAAO1B,MAAM,CAAC4B,IAAI;EAClCF,SAAS,CAACX,YAAY,CAACR,YAAY,CAAC;EACpC,OAAOP,MAAM,CAAC4B,IAAI;AACpB,CAAC,CAAC;AAEJ;;;;;;;AAOA,OAAO,MAAMC,YAAY,GACvBC,CAA8C,IAE9C3B,MAAM,CAAC4B,eAAe,CAAEC,CAAI,IAC1BhC,MAAM,CAACwB,WAAW,CAAEC,QAAQ,IAAI;EAC9B,MAAMC,SAAS,GAAG3B,OAAO,CAAC4B,cAAc,CAACF,QAAQ,EAAErB,SAAS,CAAC;EAC7D,IAAI,CAACsB,SAAS,EAAE,OAAO1B,MAAM,CAACiC,OAAO,CAACD,CAAC,CAAC;EACxCN,SAAS,CAACX,YAAY,CAACe,CAAC,CAACE,CAAC,CAAC,CAAC;EAC5B,OAAOhC,MAAM,CAACiC,OAAO,CAACD,CAAC,CAAC;AAC1B,CAAC,CAAC,CACH;AAgBH;;;;;;;AAOA,OAAO,MAAME,MAAM,gBAiBfjC,IAAI,CACN,CAAC,EACD,CACEkC,IAAO,EACPL,CAAyD,KAEzDK,IAAI,CAACC,QAAQ,CAAC;EACZC,WAAW,EAAEA,CAAA,KAAMC;CACpB,CAAC,CAACC,IAAI,CACLrC,MAAM,CAACsC,MAAM,CAAC;EACZA,MAAM,EAAErC,MAAM,CAACsC,WAAW,EAAE;EAC5BC,MAAM,EAAEb,YAAY,CAACC,CAAC;CACvB,CAAC,CACH,CACJ;AAED,MAAMQ,eAAe,gBAAGpC,MAAM,CAACyC,IAAI,EAAE,CAACzC,MAAM,CAAC0C,GAAG,EAAE;EAChDJ,MAAM,eAAErC,MAAM,CAACsC,WAAW,EAAE;EAC5BC,MAAM,eAAEvC,MAAM,CAACsC,WAAW;CAC3B,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMI,SAAS,gBAA4CX,MAAM,CACtEhC,MAAM,CAAC0C,GAAkD,EACxDE,CAAC,IAAK,CAACA,CAAC,CAACC,IAAI,CAACC,MAAM,CAAC,CACvB;AAED;;;;;;;AAOA,OAAO,MAAMC,WAAW,gBAA8Cf,MAAM,CAC1EhC,MAAM,CAAC0C,GAAyC,EAC/CE,CAAC,IAAK,CAACA,CAAC,CAAC,CACX;AAED;;;;;;;AAOA,OAAO,MAAMI,UAAU,gBAAwEhB,MAAM,CACnGhC,MAAM,CAACgD,UAAiB,EACvBJ,CAAC,IAAK,CAACA,CAAC,CAACE,MAAM,CAAC,CAClB","ignoreList":[]}

package/dist/unstable/workers/Worker.d.ts

@@ -1,4 +1,28 @@
 /**
+ * Client-side worker primitives shared by browser, Node, and Bun platform
+ * packages.
+ *
+ * A `WorkerPlatform` turns a numeric worker id into a long-lived `Worker`
+ * client using a runtime-specific `Spawner`. This module is the low-level
+ * building block used by worker-backed RPC clients and by platform adapters
+ * that need to communicate with dedicated workers, shared workers,
+ * `MessagePort`s, worker threads, or child-process transports while keeping
+ * setup, message handling, and cleanup inside `Effect` scopes.
+ *
+ * The worker protocol separates spawning from message delivery. Calls to
+ * `send` made before the platform reports readiness are buffered and flushed
+ * after `run` receives the ready signal, so a spawned worker must eventually be
+ * run or buffered messages will never leave the client. Message values are
+ * passed through `postMessage`, which means callers are responsible for
+ * encoding payloads into values supported by the selected runtime's structured
+ * clone implementation. Transfer lists can avoid copies for buffers, ports, or
+ * other transferable values, but ownership moves to the worker and invalid
+ * transfer lists surface as `WorkerSendError`s. Incoming messages are handled
+ * by forking each handler invocation into the worker run's `FiberSet`, so
+ * processing is concurrent rather than serialized; use an explicit queue,
+ * semaphore, or protocol-level acknowledgement when ordering or back pressure
+ * matters.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.ts";
@@ -11,14 +35,21 @@ declare const WorkerPlatform_base: Context.ServiceClass<WorkerPlatform, "effect/
     readonly spawn: <O = unknown, I = unknown>(id: number) => Effect.Effect<Worker<O, I>, WorkerError, Spawner>;
 }>;
 /**
- * @since 4.0.0
+ * Service that spawns effect `Worker` instances for numeric worker ids using
+ * the configured `Spawner`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export declare class WorkerPlatform extends WorkerPlatform_base {
 }
 /**
- * @since 4.0.0
+ * Effect-based worker abstraction that can send input messages and run a
+ * long-lived handler for output messages, failing with `WorkerError` or handler
+ * errors.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Worker<O = unknown, I = unknown> {
     readonly send: (message: I, transfers?: ReadonlyArray<unknown>) => Effect.Effect<void, WorkerError>;
@@ -27,43 +58,65 @@ export interface Worker<O = unknown, I = unknown> {
     } | undefined) => Effect.Effect<never, E | WorkerError, R>;
 }
 /**
- * @since 4.0.0
+ * Wraps platform-specific send and run functions into a `Worker`, translating
+ * platform ready/data messages and running the optional `onSpawn` effect when
+ * the worker reports readiness.
+ *
  * @category models
+ * @since 4.0.0
  */
 export declare const makeUnsafe: (options: {
     readonly send: (message: unknown, transfers?: ReadonlyArray<unknown>) => Effect.Effect<void, WorkerError>;
     readonly run: <A, E, R>(handler: (message: PlatformMessage) => Effect.Effect<A, E, R>) => Effect.Effect<never, E | WorkerError, R>;
 }) => Worker<any, any>;
 /**
- * @since 4.0.0
+ * Internal worker platform protocol message: `[0]` signals readiness and
+ * `[1, payload]` carries data.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type PlatformMessage = readonly [ready: 0] | readonly [data: 1, unknown];
 /**
- * @since 4.0.0
+ * Phantom identifier for the service that maps worker ids to platform-specific
+ * worker instances.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Spawner {
     readonly _: unique symbol;
 }
 /**
- * @since 4.0.0
+ * Context service tag for the worker `SpawnerFn`.
+ *
  * @category tags
+ * @since 4.0.0
  */
 export declare const Spawner: Context.Service<Spawner, SpawnerFn<unknown>>;
 /**
- * @since 4.0.0
+ * Function that creates or locates a platform-specific worker instance for a
+ * numeric worker id.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface SpawnerFn<W = unknown> {
     (id: number): W;
 }
 /**
- * @since 4.0.0
+ * Creates a layer that provides a worker `Spawner` service from a `SpawnerFn`.
+ *
  * @category layers
+ * @since 4.0.0
  */
 export declare const layerSpawner: <W = unknown>(spawner: SpawnerFn<W>) => Layer.Layer<Spawner>;
 /**
+ * Creates a `WorkerPlatform` from platform-specific setup and listen hooks,
+ * buffering sent messages until the worker is ready and scoping port cleanup to
+ * the worker run.
+ *
+ * @category constructors
  * @since 4.0.0
  */
 export declare const makePlatform: <W>() => <P extends {