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

package/dist/Pipeable.js.map

@@ -1 +1 @@
-{"version":3,"file":"Pipeable.js","names":["pipeArguments","self","args","length","ret","i","len","Prototype","pipe","arguments","Class","PipeableBase","prototype","Mixin","klass"],"sources":["../src/Pipeable.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAqfA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMA,aAAa,GAAGA,CAAIC,IAAO,EAAEC,IAAgB,KAAa;EACrE,QAAQA,IAAI,CAACC,MAAM;IACjB,KAAK,CAAC;MACJ,OAAOF,IAAI;IACb,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC;IACtB,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC;IAC/B,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC;IACxC,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9F;MAAS;QACP,IAAIG,GAAG,GAAGH,IAAI;QACd,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEC,GAAG,GAAGJ,IAAI,CAACC,MAAM,EAAEE,CAAC,GAAGC,GAAG,EAAED,CAAC,EAAE,EAAE;UAC/CD,GAAG,GAAGF,IAAI,CAACG,CAAC,CAAC,CAACD,GAAG,CAAC;QACpB;QACA,OAAOA,GAAG;MACZ;EACF;AACF,CAAC;AAED;;;AAGA,OAAO,MAAMG,SAAS,GAAa;EACjCC,IAAIA,CAAA;IACF,OAAOR,aAAa,CAAC,IAAI,EAAES,SAAS,CAAC;EACvC;CACD;AAED;;;;AAIA,OAAO,MAAMC,KAAK,gBAAuB;EACvC,SAASC,YAAYA,CAAA,GAAI;EACzBA,YAAY,CAACC,SAAS,GAAGL,SAAS;EAClC,OAAOI,YAAmB;AAC5B,CAAC,CAAC,CAAE;AAUJ;;;;AAIA,OAAO,MAAME,KAAK,GAChBC,KAAY,IAEX,cAAcA,KAAK;EAClBN,IAAIA,CAAA;IACF,OAAOR,aAAa,CAAC,IAAI,EAAES,SAAS,CAAC;EACvC;CACA","ignoreList":[]}
+{"version":3,"file":"Pipeable.js","names":["pipeArguments","self","args","length","ret","i","len","Prototype","pipe","arguments","Class","PipeableBase","prototype","Mixin","klass"],"sources":["../src/Pipeable.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;AAghBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,OAAO,MAAMA,aAAa,GAAGA,CAAIC,IAAO,EAAEC,IAAgB,KAAa;EACrE,QAAQA,IAAI,CAACC,MAAM;IACjB,KAAK,CAAC;MACJ,OAAOF,IAAI;IACb,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC;IACtB,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC;IAC/B,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC;IACxC,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,KAAK,CAAC;MACJ,OAAOC,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACA,IAAI,CAAC,CAAC,CAAC,CAACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9F;MAAS;QACP,IAAIG,GAAG,GAAGH,IAAI;QACd,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEC,GAAG,GAAGJ,IAAI,CAACC,MAAM,EAAEE,CAAC,GAAGC,GAAG,EAAED,CAAC,EAAE,EAAE;UAC/CD,GAAG,GAAGF,IAAI,CAACG,CAAC,CAAC,CAACD,GAAG,CAAC;QACpB;QACA,OAAOA,GAAG;MACZ;EACF;AACF,CAAC;AAED;;;;;;;;AAQA,OAAO,MAAMG,SAAS,GAAa;EACjCC,IAAIA,CAAA;IACF,OAAOR,aAAa,CAAC,IAAI,EAAES,SAAS,CAAC;EACvC;CACD;AAED;;;;;;;;;;AAUA,OAAO,MAAMC,KAAK,gBAAuB;EACvC,SAASC,YAAYA,CAAA,GAAI;EACzBA,YAAY,CAACC,SAAS,GAAGL,SAAS;EAClC,OAAOI,YAAmB;AAC5B,CAAC,CAAC,CAAE;AAYJ;;;;;;;;;;AAUA,OAAO,MAAME,KAAK,GAChBC,KAAY,IACqB,cAAcA,KAAK;EACpDN,IAAIA,CAAA;IACF,OAAOR,aAAa,CAAC,IAAI,EAAES,SAAS,CAAC;EACvC;CACA","ignoreList":[]}

package/dist/PlatformError.d.ts

@@ -1,4 +1,34 @@
 /**
+ * The `PlatformError` module defines the normalized error model used by
+ * platform APIs when adapting host operations into Effect programs. It gives
+ * callers a stable `PlatformError` wrapper whose `reason` is either a
+ * `BadArgument`, for invalid inputs rejected before an operation runs, or a
+ * `SystemError`, for failures reported by the host platform or operating
+ * system.
+ *
+ * Use this module when implementing or consuming platform services such as
+ * file systems, terminal access, sockets, or other environment-specific APIs.
+ * `SystemError` intentionally groups many low-level failures into a small set
+ * of portable tags like `NotFound`, `PermissionDenied`, and `TimedOut`, while
+ * still preserving operation details such as the module, method, syscall, path
+ * or descriptor, description, and original cause when available.
+ *
+ * **Common tasks**
+ *
+ * - Create platform failures from system operations with {@link systemError}
+ * - Report rejected caller input with {@link badArgument}
+ * - Inspect the underlying reason via {@link PlatformError.reason}
+ * - Match normalized system failures with {@link SystemErrorTag}
+ *
+ * **Gotchas**
+ *
+ * - `PlatformError` is a wrapper; inspect `reason` to distinguish
+ *   `BadArgument` from `SystemError`
+ * - `SystemErrorTag` values are normalized categories, not necessarily raw
+ *   platform error codes
+ * - The original cause is preserved when provided, but portable handling
+ *   should rely on the normalized fields
+ *
  * @since 4.0.0
  */
 import * as Data from "./Data.ts";
@@ -7,8 +37,13 @@ declare const BadArgument_base: new <A extends Record<string, any> = {}>(args: i
     readonly _tag: "BadArgument";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Error data for an invalid argument passed to a platform API.
+ *
+ * The error records the module and method that rejected the argument, with an
+ * optional description and cause. It is usually wrapped in `PlatformError`.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare class BadArgument extends BadArgument_base<{
     module: string;
@@ -17,18 +52,31 @@ export declare class BadArgument extends BadArgument_base<{
     cause?: unknown;
 }> {
     /**
+     * Formats the module, method, and optional description that rejected the argument.
+     *
      * @since 4.0.0
      */
     get message(): string;
 }
 /**
- * @since 4.0.0
+ * Normalized category for failures reported by platform or system operations.
+ *
+ * The tags group lower-level platform errors into a stable set such as
+ * `NotFound`, `PermissionDenied`, `TimedOut`, and `Unknown`.
+ *
  * @category Model
+ * @since 4.0.0
  */
 export type SystemErrorTag = "AlreadyExists" | "BadResource" | "Busy" | "InvalidData" | "NotFound" | "PermissionDenied" | "TimedOut" | "UnexpectedEof" | "Unknown" | "WouldBlock" | "WriteZero";
 /**
- * @since 4.0.0
+ * Error data for a platform or system operation failure.
+ *
+ * The error records a normalized `_tag`, the module and method that failed,
+ * and optional details such as the syscall, path or descriptor, description,
+ * and original cause. It is usually wrapped in `PlatformError`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export declare class SystemError extends Data.Error<{
     _tag: SystemErrorTag;
@@ -40,6 +88,8 @@ export declare class SystemError extends Data.Error<{
     cause?: unknown;
 }> {
     /**
+     * Formats the normalized system error tag with operation and path details.
+     *
      * @since 4.0.0
      */
     get message(): string;
@@ -48,22 +98,35 @@ declare const PlatformError_base: new <A extends Record<string, any> = {}>(args:
     readonly _tag: "PlatformError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Tagged error used by platform APIs to report either invalid arguments or
+ * system-level failures.
+ *
+ * The `reason` field contains the underlying `BadArgument` or `SystemError`.
+ * When that reason has a cause, the cause is preserved on the wrapper.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export declare class PlatformError extends PlatformError_base<{
     reason: BadArgument | SystemError;
 }> {
     constructor(reason: BadArgument | SystemError);
     /**
+     * Marks this value as a platform error wrapper for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [TypeId]: typeof TypeId;
     get message(): string;
 }
 /**
- * @since 4.0.0
+ * Creates a `PlatformError` whose reason is a `SystemError`.
+ *
+ * Use this helper when adapting an operating-system or platform failure into
+ * the normalized platform error model.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const systemError: (options: {
     readonly _tag: SystemErrorTag;
@@ -75,8 +138,13 @@ export declare const systemError: (options: {
     readonly cause?: unknown;
 }) => PlatformError;
 /**
- * @since 4.0.0
+ * Creates a `PlatformError` whose reason is a `BadArgument`.
+ *
+ * Use this helper when a platform API rejects caller input before performing
+ * the underlying operation.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const badArgument: (options: {
     readonly module: string;

package/dist/PlatformError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformError.d.ts","sourceRoot":"","sources":["../src/PlatformError.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,QAAA,MAAM,MAAM,mCAAmC,CAAA;;;;AAE/C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,iBAAgC;IAC/D,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAC;IACA;;OAEG;IACH,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,aAAa,GACb,MAAM,GACN,aAAa,GACb,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,eAAe,GACf,SAAS,GACT,YAAY,GACZ,WAAW,CAAA;AAEf;;;GAGG;AACH,qBAAa,WAAY,SAAQ,IAAI,CAAC,KAAK,CAAC;IAC1C,IAAI,EAAE,cAAc,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC9C,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAC;IACA;;OAEG;IACH,IAAa,OAAO,IAAI,MAAM,CAI7B;CACF;;;;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,mBAAkC;IACnE,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;CAClC,CAAC;gBACY,MAAM,EAAE,WAAW,GAAG,WAAW;IAQ7C;;OAEG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAS;IAEzC,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS;IACnC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB,KAAG,aAA4D,CAAA;AAEhE;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB,KAAG,aAA4D,CAAA"}
+{"version":3,"file":"PlatformError.d.ts","sourceRoot":"","sources":["../src/PlatformError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,QAAA,MAAM,MAAM,mCAAmC,CAAA;;;;AAE/C;;;;;;;;GAQG;AACH,qBAAa,WAAY,SAAQ,iBAAgC;IAC/D,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAC;IACA;;;;OAIG;IACH,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GACtB,eAAe,GACf,aAAa,GACb,MAAM,GACN,aAAa,GACb,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,eAAe,GACf,SAAS,GACT,YAAY,GACZ,WAAW,CAAA;AAEf;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,IAAI,CAAC,KAAK,CAAC;IAC1C,IAAI,EAAE,cAAc,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IAC9C,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAC;IACA;;;;OAIG;IACH,IAAa,OAAO,IAAI,MAAM,CAI7B;CACF;;;;AAED;;;;;;;;;GASG;AACH,qBAAa,aAAc,SAAQ,mBAAkC;IACnE,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;CAClC,CAAC;gBACY,MAAM,EAAE,WAAW,GAAG,WAAW;IAQ7C;;;;OAIG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAS;IAEzC,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS;IACnC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB,KAAG,aAA4D,CAAA;AAEhE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB,KAAG,aAA4D,CAAA"}

package/dist/PlatformError.js

@@ -1,14 +1,51 @@
 /**
+ * The `PlatformError` module defines the normalized error model used by
+ * platform APIs when adapting host operations into Effect programs. It gives
+ * callers a stable `PlatformError` wrapper whose `reason` is either a
+ * `BadArgument`, for invalid inputs rejected before an operation runs, or a
+ * `SystemError`, for failures reported by the host platform or operating
+ * system.
+ *
+ * Use this module when implementing or consuming platform services such as
+ * file systems, terminal access, sockets, or other environment-specific APIs.
+ * `SystemError` intentionally groups many low-level failures into a small set
+ * of portable tags like `NotFound`, `PermissionDenied`, and `TimedOut`, while
+ * still preserving operation details such as the module, method, syscall, path
+ * or descriptor, description, and original cause when available.
+ *
+ * **Common tasks**
+ *
+ * - Create platform failures from system operations with {@link systemError}
+ * - Report rejected caller input with {@link badArgument}
+ * - Inspect the underlying reason via {@link PlatformError.reason}
+ * - Match normalized system failures with {@link SystemErrorTag}
+ *
+ * **Gotchas**
+ *
+ * - `PlatformError` is a wrapper; inspect `reason` to distinguish
+ *   `BadArgument` from `SystemError`
+ * - `SystemErrorTag` values are normalized categories, not necessarily raw
+ *   platform error codes
+ * - The original cause is preserved when provided, but portable handling
+ *   should rely on the normalized fields
+ *
  * @since 4.0.0
  */
 import * as Data from "./Data.js";
 const TypeId = "~effect/platform/PlatformError";
 /**
- * @since 4.0.0
+ * Error data for an invalid argument passed to a platform API.
+ *
+ * The error records the module and method that rejected the argument, with an
+ * optional description and cause. It is usually wrapped in `PlatformError`.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export class BadArgument extends /*#__PURE__*/Data.TaggedError("BadArgument") {
   /**
+   * Formats the module, method, and optional description that rejected the argument.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -16,11 +53,19 @@ export class BadArgument extends /*#__PURE__*/Data.TaggedError("BadArgument") {
   }
 }
 /**
- * @since 4.0.0
+ * Error data for a platform or system operation failure.
+ *
+ * The error records a normalized `_tag`, the module and method that failed,
+ * and optional details such as the syscall, path or descriptor, description,
+ * and original cause. It is usually wrapped in `PlatformError`.
+ *
  * @category models
+ * @since 4.0.0
  */
 export class SystemError extends Data.Error {
   /**
+   * Formats the normalized system error tag with operation and path details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -28,8 +73,14 @@ export class SystemError extends Data.Error {
   }
 }
 /**
- * @since 4.0.0
+ * Tagged error used by platform APIs to report either invalid arguments or
+ * system-level failures.
+ *
+ * The `reason` field contains the underlying `BadArgument` or `SystemError`.
+ * When that reason has a cause, the cause is preserved on the wrapper.
+ *
  * @category Models
+ * @since 4.0.0
  */
 export class PlatformError extends /*#__PURE__*/Data.TaggedError("PlatformError") {
   constructor(reason) {
@@ -45,6 +96,8 @@ export class PlatformError extends /*#__PURE__*/Data.TaggedError("PlatformError"
     }
   }
   /**
+   * Marks this value as a platform error wrapper for runtime guards.
+   *
    * @since 4.0.0
    */
   [TypeId] = TypeId;
@@ -53,13 +106,23 @@ export class PlatformError extends /*#__PURE__*/Data.TaggedError("PlatformError"
   }
 }
 /**
- * @since 4.0.0
+ * Creates a `PlatformError` whose reason is a `SystemError`.
+ *
+ * Use this helper when adapting an operating-system or platform failure into
+ * the normalized platform error model.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const systemError = options => new PlatformError(new SystemError(options));
 /**
- * @since 4.0.0
+ * Creates a `PlatformError` whose reason is a `BadArgument`.
+ *
+ * Use this helper when a platform API rejects caller input before performing
+ * the underlying operation.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const badArgument = options => new PlatformError(new BadArgument(options));
 //# sourceMappingURL=PlatformError.js.map

package/dist/PlatformError.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformError.js","names":["Data","TypeId","BadArgument","TaggedError","message","module","method","description","SystemError","Error","_tag","pathOrDescriptor","undefined","PlatformError","constructor","reason","cause","systemError","options","badArgument"],"sources":["../src/PlatformError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,IAAI,MAAM,WAAW;AAEjC,MAAMC,MAAM,GAAG,gCAAgC;AAE/C;;;;AAIA,OAAM,MAAOC,WAAY,sBAAQF,IAAI,CAACG,WAAW,CAAC,aAAa,CAK7D;EACA;;;EAGA,IAAaC,OAAOA,CAAA;IAClB,OAAO,GAAG,IAAI,CAACC,MAAM,IAAI,IAAI,CAACC,MAAM,GAAG,IAAI,CAACC,WAAW,GAAG,KAAK,IAAI,CAACA,WAAW,EAAE,GAAG,EAAE,EAAE;EAC1F;;AAoBF;;;;AAIA,OAAM,MAAOC,WAAY,SAAQR,IAAI,CAACS,KAQpC;EACA;;;EAGA,IAAaL,OAAOA,CAAA;IAClB,OAAO,GAAG,IAAI,CAACM,IAAI,KAAK,IAAI,CAACL,MAAM,IAAI,IAAI,CAACC,MAAM,GAChD,IAAI,CAACK,gBAAgB,KAAKC,SAAS,GAAG,KAAK,IAAI,CAACD,gBAAgB,GAAG,GAAG,EACxE,GAAG,IAAI,CAACJ,WAAW,GAAG,KAAK,IAAI,CAACA,WAAW,EAAE,GAAG,EAAE,EAAE;EACtD;;AAGF;;;;AAIA,OAAM,MAAOM,aAAc,sBAAQb,IAAI,CAACG,WAAW,CAAC,eAAe,CAEjE;EACAW,YAAYC,MAAiC;IAC3C,IAAI,OAAO,IAAIA,MAAM,EAAE;MACrB,KAAK,CAAC;QAAEA,MAAM;QAAEC,KAAK,EAAED,MAAM,CAACC;MAAK,CAAS,CAAC;IAC/C,CAAC,MAAM;MACL,KAAK,CAAC;QAAED;MAAM,CAAE,CAAC;IACnB;EACF;EAEA;;;EAGS,CAACd,MAAM,IAAmBA,MAAM;EAEzC,IAAaG,OAAOA,CAAA;IAClB,OAAO,IAAI,CAACW,MAAM,CAACX,OAAO;EAC5B;;AAGF;;;;AAIA,OAAO,MAAMa,WAAW,GAAIC,OAQ3B,IAAoB,IAAIL,aAAa,CAAC,IAAIL,WAAW,CAACU,OAAO,CAAC,CAAC;AAEhE;;;;AAIA,OAAO,MAAMC,WAAW,GAAID,OAK3B,IAAoB,IAAIL,aAAa,CAAC,IAAIX,WAAW,CAACgB,OAAO,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"PlatformError.js","names":["Data","TypeId","BadArgument","TaggedError","message","module","method","description","SystemError","Error","_tag","pathOrDescriptor","undefined","PlatformError","constructor","reason","cause","systemError","options","badArgument"],"sources":["../src/PlatformError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,KAAKA,IAAI,MAAM,WAAW;AAEjC,MAAMC,MAAM,GAAG,gCAAgC;AAE/C;;;;;;;;;AASA,OAAM,MAAOC,WAAY,sBAAQF,IAAI,CAACG,WAAW,CAAC,aAAa,CAK7D;EACA;;;;;EAKA,IAAaC,OAAOA,CAAA;IAClB,OAAO,GAAG,IAAI,CAACC,MAAM,IAAI,IAAI,CAACC,MAAM,GAAG,IAAI,CAACC,WAAW,GAAG,KAAK,IAAI,CAACA,WAAW,EAAE,GAAG,EAAE,EAAE;EAC1F;;AAyBF;;;;;;;;;;AAUA,OAAM,MAAOC,WAAY,SAAQR,IAAI,CAACS,KAQpC;EACA;;;;;EAKA,IAAaL,OAAOA,CAAA;IAClB,OAAO,GAAG,IAAI,CAACM,IAAI,KAAK,IAAI,CAACL,MAAM,IAAI,IAAI,CAACC,MAAM,GAChD,IAAI,CAACK,gBAAgB,KAAKC,SAAS,GAAG,KAAK,IAAI,CAACD,gBAAgB,GAAG,GAAG,EACxE,GAAG,IAAI,CAACJ,WAAW,GAAG,KAAK,IAAI,CAACA,WAAW,EAAE,GAAG,EAAE,EAAE;EACtD;;AAGF;;;;;;;;;;AAUA,OAAM,MAAOM,aAAc,sBAAQb,IAAI,CAACG,WAAW,CAAC,eAAe,CAEjE;EACAW,YAAYC,MAAiC;IAC3C,IAAI,OAAO,IAAIA,MAAM,EAAE;MACrB,KAAK,CAAC;QAAEA,MAAM;QAAEC,KAAK,EAAED,MAAM,CAACC;MAAK,CAAS,CAAC;IAC/C,CAAC,MAAM;MACL,KAAK,CAAC;QAAED;MAAM,CAAE,CAAC;IACnB;EACF;EAEA;;;;;EAKS,CAACd,MAAM,IAAmBA,MAAM;EAEzC,IAAaG,OAAOA,CAAA;IAClB,OAAO,IAAI,CAACW,MAAM,CAACX,OAAO;EAC5B;;AAGF;;;;;;;;;AASA,OAAO,MAAMa,WAAW,GAAIC,OAQ3B,IAAoB,IAAIL,aAAa,CAAC,IAAIL,WAAW,CAACU,OAAO,CAAC,CAAC;AAEhE;;;;;;;;;AASA,OAAO,MAAMC,WAAW,GAAID,OAK3B,IAAoB,IAAIL,aAAa,CAAC,IAAIX,WAAW,CAACgB,OAAO,CAAC,CAAC","ignoreList":[]}

package/dist/Pool.d.ts

@@ -11,8 +11,8 @@ declare const TypeId = "~effect/Pool";
  * associated with the acquisition and release of resources. An attempt to get
  * an item `A` from a pool may fail with an error of type `E`.
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface Pool<in out A, in out E = never> extends Pipeable {
     readonly [TypeId]: typeof TypeId;
@@ -20,8 +20,15 @@ export interface Pool<in out A, in out E = never> extends Pipeable {
     readonly state: State<A, E>;
 }
 /**
- * @since 4.0.0
+ * Normalized configuration used by a `Pool`.
+ *
+ * **Details**
+ *
+ * The config stores the acquire effect, size bounds, per-item concurrency,
+ * target utilization, and resizing strategy used by the pool implementation.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Config<A, E> {
     readonly acquire: Effect.Effect<A, E, Scope.Scope>;
@@ -32,8 +39,17 @@ export interface Config<A, E> {
     readonly targetUtilization: number;
 }
 /**
- * @since 4.0.0
+ * Mutable runtime state maintained by a `Pool`.
+ *
+ * **Details**
+ *
+ * This state tracks the pool scope, active and available items, invalidated
+ * items, semaphores, waiters, and shutdown status. It is exposed for
+ * inspection and implementation support; user code should prefer the
+ * high-level pool operations.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface State<A, E> {
     readonly scope: Scope.Scope;
@@ -47,8 +63,16 @@ export interface State<A, E> {
     waiters: number;
 }
 /**
- * @since 4.0.0
+ * Internal record for a value managed by a `Pool`.
+ *
+ * **Details**
+ *
+ * Each item stores the acquisition `Exit`, its finalizer, the current
+ * reference count, and whether automatic reclaiming has been disabled because
+ * the item was invalidated.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface PoolItem<A, E> {
     readonly exit: Exit.Exit<A, E>;
@@ -57,8 +81,17 @@ export interface PoolItem<A, E> {
     disableReclaim: boolean;
 }
 /**
- * @since 4.0.0
+ * Strategy used by a `Pool` to manage background resizing and item
+ * reclamation.
+ *
+ * **Details**
+ *
+ * `run` starts any strategy-specific background work, `onAcquire` is invoked
+ * when an item is acquired, and `reclaim` selects an item that can be removed
+ * or replaced.
+ *
  * @category models
+ * @since 4.0.0
  */
 export interface Strategy<A, E> {
     readonly run: (pool: Pool<A, E>) => Effect.Effect<void>;
@@ -68,8 +101,8 @@ export interface Strategy<A, E> {
 /**
  * Returns `true` if the specified value is a `Pool`, `false` otherwise.
  *
- * @since 2.0.0
  * @category refinements
+ * @since 2.0.0
  */
 export declare const isPool: (u: unknown) => u is Pool<unknown, unknown>;
 /**
@@ -88,8 +121,8 @@ export declare const isPool: (u: unknown) => u is Pool<unknown, unknown>;
  * A `targetUtilization` of 0.5 will create new pool items when the existing items are
  * 50% utilized.
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const make: <A, E, R>(options: {
     readonly acquire: Effect.Effect<A, E, R>;
@@ -98,28 +131,22 @@ export declare const make: <A, E, R>(options: {
     readonly targetUtilization?: number | undefined;
 }) => Effect.Effect<Pool<A, E>, never, R | Scope.Scope>;
 /**
- * Makes a new pool with the specified minimum and maximum sizes and time to
- * live before a pool whose excess items are not being used will be shrunk
- * down to the minimum size. The pool is returned in a `Scope`, which governs
- * the lifetime of the pool. When the pool is shutdown because the `Scope` is
- * used, the individual items allocated by the pool will be released in some
- * unspecified order.
- *
- * By setting the `concurrency` parameter, you can control the level of concurrent
- * access per pool item. By default, the number of permits is set to `1`.
+ * Creates a scoped pool with minimum and maximum sizes and a time-to-live
+ * policy for shrinking unused excess items.
  *
- * `targetUtilization` determines when to create new pool items. It is a value
- * between 0 and 1, where 1 means only create new pool items when all the existing
- * items are fully utilized.
+ * **Details**
  *
- * A `targetUtilization` of 0.5 will create new pool items when the existing items are
- * 50% utilized.
+ * The returned pool requires `Scope`; when that scope is closed, allocated
+ * items are released in an unspecified order. `concurrency` controls how many
+ * fibers may use each pool item at once and defaults to `1`.
  *
- * The `timeToLiveStrategy` determines how items are invalidated. If set to
- * "creation", then items are invalidated based on their creation time. If set
- * to "usage", then items are invalidated based on pool usage.
+ * `targetUtilization` controls when new items are created and is clamped by the
+ * pool implementation. A value of `1` waits until existing items are fully
+ * utilized before creating more items.
  *
- * By default, the `timeToLiveStrategy` is set to "usage".
+ * `timeToLiveStrategy` controls when excess items expire: `"creation"` measures
+ * from item creation, while `"usage"` measures from pool usage. The default is
+ * `"usage"`.
  *
  * ```ts skip-type-checking
  * import { Duration, Effect, Pool } from "effect"
@@ -141,8 +168,8 @@ export declare const make: <A, E, R>(options: {
  * )
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const makeWithTTL: <A, E, R>(options: {
     readonly acquire: Effect.Effect<A, E, R>;
@@ -154,8 +181,16 @@ export declare const makeWithTTL: <A, E, R>(options: {
     readonly timeToLiveStrategy?: "creation" | "usage" | undefined;
 }) => Effect.Effect<Pool<A, E>, never, R | Scope.Scope>;
 /**
- * @since 4.0.0
+ * Creates a scoped pool using a custom resizing and reclamation strategy.
+ *
+ * **Details**
+ *
+ * The returned pool requires `Scope`; closing the scope shuts down the pool and
+ * releases allocated items. Use this constructor when `make` and `makeWithTTL`
+ * do not provide the desired item lifecycle behavior.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const makeWithStrategy: <A, E, R>(options: {
     readonly acquire: Effect.Effect<A, E, R>;
@@ -170,8 +205,8 @@ export declare const makeWithStrategy: <A, E, R>(options: {
  * acquisition fails, then the returned effect will fail for that same reason.
  * Retrying a failed acquisition attempt will repeat the acquisition attempt.
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const get: <A, E>(self: Pool<A, E>) => Effect.Effect<A, E, Scope.Scope>;
 /**
@@ -179,8 +214,8 @@ export declare const get: <A, E>(self: Pool<A, E>) => Effect.Effect<A, E, Scope.
  * reallocate the item, although this reallocation may occur lazily rather
  * than eagerly.
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const invalidate: {
     /**
@@ -188,8 +223,8 @@ export declare const invalidate: {
      * reallocate the item, although this reallocation may occur lazily rather
      * than eagerly.
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <A>(item: A): <E>(self: Pool<A, E>) => Effect.Effect<void, never, Scope.Scope>;
     /**
@@ -197,8 +232,8 @@ export declare const invalidate: {
      * reallocate the item, although this reallocation may occur lazily rather
      * than eagerly.
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <A, E>(self: Pool<A, E>, item: A): Effect.Effect<void, never, Scope.Scope>;
 };

package/dist/Pool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Pool.d.ts","sourceRoot":"","sources":["../src/Pool.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,IAAI,MAAM,WAAW,CAAA;AAItC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,eAAe,CAAA;AAI5D,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C,QAAA,MAAM,MAAM,iBAAiB,CAAA;AAE7B;;;;;;;GAOG;AACH,MAAM,WAAW,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAE,SAAQ,QAAQ;IAChE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,EAAE,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAClD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACjC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAA;IAC3B,cAAc,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;IACvC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,SAAS,CAAA;IAC7C,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACnC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACvC,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,KAAK,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACzC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,cAAc,EAAE,OAAO,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACvD,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACjE,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;CAClF;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,CAA2B,CAAA;AAEzF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAChD,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAC8C,CAAA;AAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS;IAC5C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAA;IACnC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAAA;CAC/D,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAMjD,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS;IACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAClC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CA+C/C,CAAA;AAwBL;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,CAMxE,CAAA;AA+DJ;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC9E;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;CAWvE,CAAA"}
+{"version":3,"file":"Pool.d.ts","sourceRoot":"","sources":["../src/Pool.ts"],"names":[],"mappings":"AAkCA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,KAAK,KAAK,IAAI,MAAM,WAAW,CAAA;AAItC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,eAAe,CAAA;AAI5D,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C,QAAA,MAAM,MAAM,iBAAiB,CAAA;AAE7B;;;;;;;GAOG;AACH,MAAM,WAAW,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAE,SAAQ,QAAQ;IAChE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAC5B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,EAAE,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAClD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACjC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAA;CACnC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAA;IAC3B,cAAc,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAA;IACvC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,SAAS,CAAA;IAC7C,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACnC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACvC,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,KAAK,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACzC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,cAAc,EAAE,OAAO,CAAA;CACxB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACvD,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACjE,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;CAClF;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,CAA2B,CAAA;AAEzF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAChD,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAC8C,CAAA;AAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS;IAC5C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAA;IACnC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,SAAS,CAAA;CAC/D,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAMjD,CAAA;AAEH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS;IACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAClC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CA+C/C,CAAA;AAwBL;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,KAAK,CAMxE,CAAA;AA+DJ;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC9E;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;CAWvE,CAAA"}

package/dist/Pool.js

@@ -16,8 +16,8 @@ const TypeId = "~effect/Pool";
 /**
  * Returns `true` if the specified value is a `Pool`, `false` otherwise.
  *
- * @since 2.0.0
  * @category refinements
+ * @since 2.0.0
  */
 export const isPool = u => hasProperty(u, TypeId);
 /**
@@ -36,8 +36,8 @@ export const isPool = u => hasProperty(u, TypeId);
  * A `targetUtilization` of 0.5 will create new pool items when the existing items are
  * 50% utilized.
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export const make = options => makeWithStrategy({
   ...options,
@@ -46,28 +46,22 @@ export const make = options => makeWithStrategy({
   strategy: strategyNoop()
 });
 /**
- * Makes a new pool with the specified minimum and maximum sizes and time to
- * live before a pool whose excess items are not being used will be shrunk
- * down to the minimum size. The pool is returned in a `Scope`, which governs
- * the lifetime of the pool. When the pool is shutdown because the `Scope` is
- * used, the individual items allocated by the pool will be released in some
- * unspecified order.
- *
- * By setting the `concurrency` parameter, you can control the level of concurrent
- * access per pool item. By default, the number of permits is set to `1`.
+ * Creates a scoped pool with minimum and maximum sizes and a time-to-live
+ * policy for shrinking unused excess items.
  *
- * `targetUtilization` determines when to create new pool items. It is a value
- * between 0 and 1, where 1 means only create new pool items when all the existing
- * items are fully utilized.
+ * **Details**
  *
- * A `targetUtilization` of 0.5 will create new pool items when the existing items are
- * 50% utilized.
+ * The returned pool requires `Scope`; when that scope is closed, allocated
+ * items are released in an unspecified order. `concurrency` controls how many
+ * fibers may use each pool item at once and defaults to `1`.
  *
- * The `timeToLiveStrategy` determines how items are invalidated. If set to
- * "creation", then items are invalidated based on their creation time. If set
- * to "usage", then items are invalidated based on pool usage.
+ * `targetUtilization` controls when new items are created and is clamped by the
+ * pool implementation. A value of `1` waits until existing items are fully
+ * utilized before creating more items.
  *
- * By default, the `timeToLiveStrategy` is set to "usage".
+ * `timeToLiveStrategy` controls when excess items expire: `"creation"` measures
+ * from item creation, while `"usage"` measures from pool usage. The default is
+ * `"usage"`.
  *
  * ```ts skip-type-checking
  * import { Duration, Effect, Pool } from "effect"
@@ -89,16 +83,24 @@ export const make = options => makeWithStrategy({
  * )
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export const makeWithTTL = options => Effect.flatMap(options.timeToLiveStrategy === "creation" ? strategyCreationTTL(options.timeToLive) : strategyUsageTTL(options.timeToLive), strategy => makeWithStrategy({
   ...options,
   strategy
 }));
 /**
- * @since 4.0.0
+ * Creates a scoped pool using a custom resizing and reclamation strategy.
+ *
+ * **Details**
+ *
+ * The returned pool requires `Scope`; closing the scope shuts down the pool and
+ * releases allocated items. Use this constructor when `make` and `makeWithTTL`
+ * do not provide the desired item lifecycle behavior.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const makeWithStrategy = options => Effect.uninterruptibleMask(Effect.fnUntraced(function* (restore) {
   const services = yield* Effect.context();
@@ -163,8 +165,8 @@ const shutdown = /*#__PURE__*/Effect.fnUntraced(function* (self) {
  * acquisition fails, then the returned effect will fail for that same reason.
  * Retrying a failed acquisition attempt will repeat the acquisition attempt.
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export const get = self => Effect.suspend(() => {
   if (self.state.isShuttingDown) {
@@ -216,8 +218,8 @@ const getPoolItemInner = /*#__PURE__*/Effect.fnUntraced(function* (self) {
  * reallocate the item, although this reallocation may occur lazily rather
  * than eagerly.
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export const invalidate = /*#__PURE__*/dual(2, (self, item) => Effect.suspend(() => {
   if (self.state.isShuttingDown) return Effect.void;