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

package/dist/Request.d.ts

@@ -1,15 +1,46 @@
 /**
- * The `Request` module provides a way to model requests to external data sources
- * in a functional and composable manner. Requests represent descriptions of
- * operations that can be batched, cached, and executed efficiently.
- *
- * A `Request<A, E, R>` represents a request that:
- * - Yields a value of type `A` on success
- * - Can fail with an error of type `E`
- * - Requires services of type `R`
- *
- * Requests are primarily used with RequestResolver to implement efficient
- * data fetching patterns, including automatic batching and caching.
+ * The `Request` module defines typed request values for data loading with
+ * `Effect.request`. A request is a description of work, not the execution of
+ * that work: it records the success type, typed error, service requirements,
+ * and the fields needed by a resolver to perform one logical operation.
+ *
+ * Requests are designed to be paired with a `RequestResolver`, which receives
+ * pending request entries, batches or caches them when possible, and completes
+ * each entry with a result. This lets calling code ask for data declaratively
+ * while resolver code owns the backend-specific loading logic.
+ *
+ * **Mental model**
+ *
+ * - `Request<A, E, R>` describes one operation that succeeds with `A`, fails
+ *   with `E`, and may require services `R`
+ * - Constructors such as {@link of}, {@link tagged}, {@link Class}, and
+ *   {@link TaggedClass} attach the request marker and structural behavior
+ *   expected by the request runtime
+ * - A resolver receives {@link Entry} values; each entry contains the original
+ *   request, the captured context, and a completion callback
+ * - Completion helpers such as {@link succeed}, {@link fail},
+ *   {@link failCause}, {@link complete}, and {@link completeEffect} turn
+ *   resolver results into the `Exit` expected by the waiting fiber
+ *
+ * **Common tasks**
+ *
+ * - Define request shapes with {@link Request}, {@link Class}, or
+ *   {@link TaggedClass}
+ * - Build lightweight request constructors with {@link of} or {@link tagged}
+ * - Check unknown values with {@link isRequest}
+ * - Complete pending resolver entries with {@link succeed}, {@link fail},
+ *   {@link failCause}, {@link complete}, or {@link completeEffect}
+ * - Extract request type members with {@link Success}, {@link Error},
+ *   {@link Services}, and {@link Result}
+ *
+ * **Gotchas**
+ *
+ * - Creating a request value does not run anything; it must be submitted with
+ *   `Effect.request` and handled by a resolver
+ * - Resolver implementations must complete every {@link Entry} they receive,
+ *   otherwise the fiber waiting for that request will not receive a value
+ * - Cached and deduplicated requests depend on request identity and structural
+ *   equality, so include only stable fields that describe the logical operation
  *
  * @since 2.0.0
  */
@@ -49,6 +80,17 @@ export interface Request<out A, out E = never, out R = never> extends Variance<A
  * Alias for any `Request`, regardless of its success, error, or service
  * requirements.
  *
+ * **When to use**
+ *
+ * Use as a generic constraint for APIs that accept any request while preserving
+ * each concrete request's success, error, and service types.
+ *
+ * @see {@link Request} for the request interface
+ * @see {@link Success} for extracting a request's success type
+ * @see {@link Error} for extracting a request's error type
+ * @see {@link Services} for extracting a request's service requirements
+ * @see {@link Result} for the exit type produced by completing a request
+ *
  * @category models
  * @since 4.0.0
  */
@@ -180,12 +222,12 @@ export type Result<T extends Request<any, any, any>> = T extends Request<infer A
  * `Request.TaggedClass`. Most users should use those constructors instead of
  * interacting with the prototype directly.
  *
- * @category models
+ * @category prototypes
  * @since 4.0.0
  */
 export declare const RequestPrototype: Request<any, any, any>;
 /**
- * Tests if a value is a `Request`.
+ * Checks whether a value is a `Request`.
  *
  * **Example** (Checking request values)
  *
@@ -288,7 +330,7 @@ export declare const tagged: <R extends Request<any, any, any> & {
     _tag: string;
 }>(tag: R["_tag"]) => Constructor<R, "_tag">;
 /**
- * Base class constructor for defining request types with TypeScript classes.
+ * Defines request types with TypeScript classes.
  *
  * **Details**
  *
@@ -345,24 +387,51 @@ export declare const TaggedClass: <Tag extends string>(tag: Tag) => new <A exten
     readonly _tag: Tag;
 };
 /**
- * Completes a request entry with the provided result. This is typically used
- * within RequestResolver implementations to fulfill pending requests.
+ * Completes a request entry with the provided result.
+ *
+ * **When to use**
+ *
+ * Use to finish a `Request.Entry` when you already have the request's final
+ * `Exit` result.
+ *
+ * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
+ * @see {@link succeed} for completing an entry with a successful value
+ * @see {@link fail} for completing an entry with a typed failure
+ * @see {@link failCause} for completing an entry with a failure `Cause`
  *
  * @category completion
  * @since 2.0.0
  */
 export declare const complete: {
     /**
-     * Completes a request entry with the provided result. This is typically used
-     * within RequestResolver implementations to fulfill pending requests.
+     * Completes a request entry with the provided result.
+     *
+     * **When to use**
+     *
+     * Use to finish a `Request.Entry` when you already have the request's final
+     * `Exit` result.
+     *
+     * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
+     * @see {@link succeed} for completing an entry with a successful value
+     * @see {@link fail} for completing an entry with a typed failure
+     * @see {@link failCause} for completing an entry with a failure `Cause`
      *
      * @category completion
      * @since 2.0.0
      */
     <A extends Any>(result: Result<A>): (self: Entry<A>) => Effect.Effect<void>;
     /**
-     * Completes a request entry with the provided result. This is typically used
-     * within RequestResolver implementations to fulfill pending requests.
+     * Completes a request entry with the provided result.
+     *
+     * **When to use**
+     *
+     * Use to finish a `Request.Entry` when you already have the request's final
+     * `Exit` result.
+     *
+     * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
+     * @see {@link succeed} for completing an entry with a successful value
+     * @see {@link fail} for completing an entry with a typed failure
+     * @see {@link failCause} for completing an entry with a failure `Cause`
      *
      * @category completion
      * @since 2.0.0
@@ -372,11 +441,24 @@ export declare const complete: {
 /**
  * Completes a request entry with the result of an effect.
  *
+ * **When to use**
+ *
+ * Use to finish a `Request.Entry` by running an effect whose success or typed
+ * failure should become the request result.
+ *
  * **Details**
  *
  * If the effect succeeds, the entry is completed successfully with its value.
- * If the effect fails, the entry is completed with that failure. The returned
- * effect itself does not fail with the request error.
+ * If the effect fails, the entry is completed with that failure.
+ *
+ * **Gotchas**
+ *
+ * The returned effect itself does not fail with the request error.
+ *
+ * @see {@link complete} for completing an entry with a prebuilt `Exit`
+ * @see {@link succeed} for completing an entry with a successful value
+ * @see {@link fail} for completing an entry with a typed failure
+ * @see {@link failCause} for completing an entry with a failure `Cause`
  *
  * @category completion
  * @since 2.0.0
@@ -385,11 +467,24 @@ export declare const completeEffect: {
     /**
      * Completes a request entry with the result of an effect.
      *
+     * **When to use**
+     *
+     * Use to finish a `Request.Entry` by running an effect whose success or typed
+     * failure should become the request result.
+     *
      * **Details**
      *
      * If the effect succeeds, the entry is completed successfully with its value.
-     * If the effect fails, the entry is completed with that failure. The returned
-     * effect itself does not fail with the request error.
+     * If the effect fails, the entry is completed with that failure.
+     *
+     * **Gotchas**
+     *
+     * The returned effect itself does not fail with the request error.
+     *
+     * @see {@link complete} for completing an entry with a prebuilt `Exit`
+     * @see {@link succeed} for completing an entry with a successful value
+     * @see {@link fail} for completing an entry with a typed failure
+     * @see {@link failCause} for completing an entry with a failure `Cause`
      *
      * @category completion
      * @since 2.0.0
@@ -398,11 +493,24 @@ export declare const completeEffect: {
     /**
      * Completes a request entry with the result of an effect.
      *
+     * **When to use**
+     *
+     * Use to finish a `Request.Entry` by running an effect whose success or typed
+     * failure should become the request result.
+     *
      * **Details**
      *
      * If the effect succeeds, the entry is completed successfully with its value.
-     * If the effect fails, the entry is completed with that failure. The returned
-     * effect itself does not fail with the request error.
+     * If the effect fails, the entry is completed with that failure.
+     *
+     * **Gotchas**
+     *
+     * The returned effect itself does not fail with the request error.
+     *
+     * @see {@link complete} for completing an entry with a prebuilt `Exit`
+     * @see {@link succeed} for completing an entry with a successful value
+     * @see {@link fail} for completing an entry with a typed failure
+     * @see {@link failCause} for completing an entry with a failure `Cause`
      *
      * @category completion
      * @since 2.0.0
@@ -412,6 +520,16 @@ export declare const completeEffect: {
 /**
  * Completes a request entry with a typed failure.
  *
+ * **When to use**
+ *
+ * Use to report a request-specific typed error while implementing a
+ * `RequestResolver`.
+ *
+ * @see {@link failCause} for completing an entry with a full `Cause`
+ * @see {@link complete} for completing an entry with an existing `Exit`
+ * @see {@link completeEffect} for completing an entry from an effect result
+ * @see {@link succeed} for completing an entry successfully
+ *
  * @category completion
  * @since 2.0.0
  */
@@ -419,6 +537,16 @@ export declare const fail: {
     /**
      * Completes a request entry with a typed failure.
      *
+     * **When to use**
+     *
+     * Use to report a request-specific typed error while implementing a
+     * `RequestResolver`.
+     *
+     * @see {@link failCause} for completing an entry with a full `Cause`
+     * @see {@link complete} for completing an entry with an existing `Exit`
+     * @see {@link completeEffect} for completing an entry from an effect result
+     * @see {@link succeed} for completing an entry successfully
+     *
      * @category completion
      * @since 2.0.0
      */
@@ -426,6 +554,16 @@ export declare const fail: {
     /**
      * Completes a request entry with a typed failure.
      *
+     * **When to use**
+     *
+     * Use to report a request-specific typed error while implementing a
+     * `RequestResolver`.
+     *
+     * @see {@link failCause} for completing an entry with a full `Cause`
+     * @see {@link complete} for completing an entry with an existing `Exit`
+     * @see {@link completeEffect} for completing an entry from an effect result
+     * @see {@link succeed} for completing an entry successfully
+     *
      * @category completion
      * @since 2.0.0
      */
@@ -434,10 +572,15 @@ export declare const fail: {
 /**
  * Completes a request entry with a failure `Cause`.
  *
- * **Details**
+ * **When to use**
+ *
+ * Use when a `RequestResolver` needs to complete an entry with structured cause
+ * information rather than only the request's typed error value.
  *
- * Use this when the request should fail with structured cause information
- * rather than only the request's typed error value.
+ * @see {@link fail} for completing an entry with a typed error value
+ * @see {@link complete} for completing an entry with an existing `Exit`
+ * @see {@link completeEffect} for completing an entry from an effect result
+ * @see {@link succeed} for completing an entry successfully
  *
  * @category completion
  * @since 2.0.0
@@ -446,10 +589,15 @@ export declare const failCause: {
     /**
      * Completes a request entry with a failure `Cause`.
      *
-     * **Details**
+     * **When to use**
+     *
+     * Use when a `RequestResolver` needs to complete an entry with structured cause
+     * information rather than only the request's typed error value.
      *
-     * Use this when the request should fail with structured cause information
-     * rather than only the request's typed error value.
+     * @see {@link fail} for completing an entry with a typed error value
+     * @see {@link complete} for completing an entry with an existing `Exit`
+     * @see {@link completeEffect} for completing an entry from an effect result
+     * @see {@link succeed} for completing an entry successfully
      *
      * @category completion
      * @since 2.0.0
@@ -458,10 +606,15 @@ export declare const failCause: {
     /**
      * Completes a request entry with a failure `Cause`.
      *
-     * **Details**
+     * **When to use**
+     *
+     * Use when a `RequestResolver` needs to complete an entry with structured cause
+     * information rather than only the request's typed error value.
      *
-     * Use this when the request should fail with structured cause information
-     * rather than only the request's typed error value.
+     * @see {@link fail} for completing an entry with a typed error value
+     * @see {@link complete} for completing an entry with an existing `Exit`
+     * @see {@link completeEffect} for completing an entry from an effect result
+     * @see {@link succeed} for completing an entry successfully
      *
      * @category completion
      * @since 2.0.0
@@ -471,6 +624,16 @@ export declare const failCause: {
 /**
  * Completes a request entry successfully with the supplied value.
  *
+ * **When to use**
+ *
+ * Use to finish a `Request.Entry` when you have a successful value for the
+ * request.
+ *
+ * @see {@link complete} for completing an entry with a prebuilt `Exit`
+ * @see {@link completeEffect} for completing an entry from an effect result
+ * @see {@link fail} for completing an entry with a typed failure
+ * @see {@link failCause} for completing an entry with a failure `Cause`
+ *
  * @category completion
  * @since 2.0.0
  */
@@ -478,6 +641,16 @@ export declare const succeed: {
     /**
      * Completes a request entry successfully with the supplied value.
      *
+     * **When to use**
+     *
+     * Use to finish a `Request.Entry` when you have a successful value for the
+     * request.
+     *
+     * @see {@link complete} for completing an entry with a prebuilt `Exit`
+     * @see {@link completeEffect} for completing an entry from an effect result
+     * @see {@link fail} for completing an entry with a typed failure
+     * @see {@link failCause} for completing an entry with a failure `Cause`
+     *
      * @category completion
      * @since 2.0.0
      */
@@ -485,6 +658,16 @@ export declare const succeed: {
     /**
      * Completes a request entry successfully with the supplied value.
      *
+     * **When to use**
+     *
+     * Use to finish a `Request.Entry` when you have a successful value for the
+     * request.
+     *
+     * @see {@link complete} for completing an entry with a prebuilt `Exit`
+     * @see {@link completeEffect} for completing an entry from an effect result
+     * @see {@link fail} for completing an entry with a typed failure
+     * @see {@link failCause} for completing an entry with a failure `Cause`
+     *
      * @category completion
      * @since 2.0.0
      */

package/dist/Request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../src/Request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,KAAK,IAAI,MAAM,WAAW,CAAA;AAKtC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM,oBAAoB,CAAA;AAEhC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,CAAE,SAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;CAAG;AAE1F;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AAExC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC3C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAC/B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAC/B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;KAChC,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,KAAK;IACtF,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAC3F;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAA;AAEtH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAC5G,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAC7G,KAAK,CAAA;AAET;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAClH,KAAK,CAAA;AAWT;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAGnD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAA2B,CAAA;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,OAAK,WAAW,CAAC,CAAC,CACf,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EACxE,KAAK,CAAC,CAAC,MAAM,CAAC,KACb,WAAW,CAAC,CAAC,EAAE,MAAM,CAMvB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,KAAK,EAAE,KAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,GAAG,KAAK,EAAE,OAAO,GAAG,KAAK,EAC5F,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,IAAI,GAChF;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,KACxF,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,CAQ9C,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,WAAW,GAAI,GAAG,SAAS,MAAM,EAC5C,KAAK,GAAG,KACP,KAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,GAAG,KAAK,EAAE,QAAQ,GAAG,KAAK,EAC5E,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,IAAI,GAChF,EAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAE,KACjG,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAA;CAI1E,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;OAMG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;OAMG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAKxE,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,EAAE;IAC3B;;;;;;;;;;;OAWG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;IACrH;;;;;;;;;;;OAWG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;CAQlH,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;OAKG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACzE;;;;;OAKG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAItE,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,EAAE;IACtB;;;;;;;;;;OAUG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtF;;;;;;;;;;OAUG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAKnF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;OAKG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;OAKG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAKxE,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAC/B;QAAC,CAAC;KAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CACjE,CAAA;IACD,eAAe,EAAE,OAAO,CAAA;IACxB,cAAc,CACZ,IAAI,EAAE,IAAI,CAAC,IAAI,CACb;QAAC,CAAC;KAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAChE;QAAC,CAAC;KAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CACjE,GACA,IAAI,CAAA;CACR;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,SAAS;IACpC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAC/B,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CACjE,CAAA;IACD,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;IACjC,QAAQ,CAAC,cAAc,EAAE,CACvB,IAAI,EAAE,IAAI,CAAC,IAAI,CACb,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,IAAE,EAAE,MAAM,IAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAChE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,IAAE,EAAE,MAAM,IAAE,CAAC,CAAC,GAAG,IAAE,GAAG,KAAK,CACjE,KACE,IAAI,CAAA;CACV,KAAG,KAAK,CAAC,CAAC,CAAY,CAAA"}
+{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../src/Request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,KAAK,IAAI,MAAM,WAAW,CAAA;AAKtC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM,oBAAoB,CAAA;AAEhC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,CAAE,SAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;CAAG;AAE1F;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AAExC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC3C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAC/B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAC/B,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;KAChC,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,KAAK;IACtF,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAC3F;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAA;AAEtH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAC5G,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAC7G,KAAK,CAAA;AAET;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAClH,KAAK,CAAA;AAWT;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAGnD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAA2B,CAAA;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,OAAK,WAAW,CAAC,CAAC,CACf,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EACxE,KAAK,CAAC,CAAC,MAAM,CAAC,KACb,WAAW,CAAC,CAAC,EAAE,MAAM,CAMvB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,KAAK,EAAE,KAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,GAAG,KAAK,EAAE,OAAO,GAAG,KAAK,EAC5F,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,IAAI,GAChF;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,KACxF,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,CAQ9C,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,WAAW,GAAI,GAAG,SAAS,MAAM,EAC5C,KAAK,GAAG,KACP,KAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,GAAG,KAAK,EAAE,QAAQ,GAAG,KAAK,EAC5E,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,IAAI,GAAG,IAAI,GAChF,EAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAE,KACjG,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAA;CAI1E,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAKxE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,cAAc,EAAE;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;IACrH;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;CAQlH,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACzE;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAItE,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,SAAS,EAAE;IACtB;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtF;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAKnF,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;OAeG;IACH,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAKxE,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAC/B;QAAC,CAAC;KAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CACjE,CAAA;IACD,eAAe,EAAE,OAAO,CAAA;IACxB,cAAc,CACZ,IAAI,EAAE,IAAI,CAAC,IAAI,CACb;QAAC,CAAC;KAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAChE;QAAC,CAAC;KAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CACjE,GACA,IAAI,CAAA;CACR;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,SAAS;IACpC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAC/B,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CACjE,CAAA;IACD,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;IACjC,QAAQ,CAAC,cAAc,EAAE,CACvB,IAAI,EAAE,IAAI,CAAC,IAAI,CACb,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,IAAE,EAAE,MAAM,IAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,EAChE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,IAAE,EAAE,MAAM,IAAE,CAAC,CAAC,GAAG,IAAE,GAAG,KAAK,CACjE,KACE,IAAI,CAAA;CACV,KAAG,KAAK,CAAC,CAAC,CAAY,CAAA"}

package/dist/Request.js

@@ -22,7 +22,7 @@ const requestVariance = /*#__PURE__*/Equal.byReferenceUnsafe({
  * `Request.TaggedClass`. Most users should use those constructors instead of
  * interacting with the prototype directly.
  *
- * @category models
+ * @category prototypes
  * @since 4.0.0
  */
 export const RequestPrototype = {
@@ -30,7 +30,7 @@ export const RequestPrototype = {
   [TypeId]: requestVariance
 };
 /**
- * Tests if a value is a `Request`.
+ * Checks whether a value is a `Request`.
  *
  * **Example** (Checking request values)
  *
@@ -136,7 +136,7 @@ export const tagged = tag => args => {
   return request;
 };
 /**
- * Base class constructor for defining request types with TypeScript classes.
+ * Defines request types with TypeScript classes.
  *
  * **Details**
  *
@@ -201,8 +201,17 @@ export const TaggedClass = tag => {
   };
 };
 /**
- * Completes a request entry with the provided result. This is typically used
- * within RequestResolver implementations to fulfill pending requests.
+ * Completes a request entry with the provided result.
+ *
+ * **When to use**
+ *
+ * Use to finish a `Request.Entry` when you already have the request's final
+ * `Exit` result.
+ *
+ * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
+ * @see {@link succeed} for completing an entry with a successful value
+ * @see {@link fail} for completing an entry with a typed failure
+ * @see {@link failCause} for completing an entry with a failure `Cause`
  *
  * @category completion
  * @since 2.0.0
@@ -211,11 +220,24 @@ export const complete = /*#__PURE__*/dual(2, (self, result) => internalEffect.sy
 /**
  * Completes a request entry with the result of an effect.
  *
+ * **When to use**
+ *
+ * Use to finish a `Request.Entry` by running an effect whose success or typed
+ * failure should become the request result.
+ *
  * **Details**
  *
  * If the effect succeeds, the entry is completed successfully with its value.
- * If the effect fails, the entry is completed with that failure. The returned
- * effect itself does not fail with the request error.
+ * If the effect fails, the entry is completed with that failure.
+ *
+ * **Gotchas**
+ *
+ * The returned effect itself does not fail with the request error.
+ *
+ * @see {@link complete} for completing an entry with a prebuilt `Exit`
+ * @see {@link succeed} for completing an entry with a successful value
+ * @see {@link fail} for completing an entry with a typed failure
+ * @see {@link failCause} for completing an entry with a failure `Cause`
  *
  * @category completion
  * @since 2.0.0
@@ -227,6 +249,16 @@ export const completeEffect = /*#__PURE__*/dual(2, (self, effect) => internalEff
 /**
  * Completes a request entry with a typed failure.
  *
+ * **When to use**
+ *
+ * Use to report a request-specific typed error while implementing a
+ * `RequestResolver`.
+ *
+ * @see {@link failCause} for completing an entry with a full `Cause`
+ * @see {@link complete} for completing an entry with an existing `Exit`
+ * @see {@link completeEffect} for completing an entry from an effect result
+ * @see {@link succeed} for completing an entry successfully
+ *
  * @category completion
  * @since 2.0.0
  */
@@ -234,10 +266,15 @@ export const fail = /*#__PURE__*/dual(2, (self, error) => complete(self, core.ex
 /**
  * Completes a request entry with a failure `Cause`.
  *
- * **Details**
+ * **When to use**
  *
- * Use this when the request should fail with structured cause information
- * rather than only the request's typed error value.
+ * Use when a `RequestResolver` needs to complete an entry with structured cause
+ * information rather than only the request's typed error value.
+ *
+ * @see {@link fail} for completing an entry with a typed error value
+ * @see {@link complete} for completing an entry with an existing `Exit`
+ * @see {@link completeEffect} for completing an entry from an effect result
+ * @see {@link succeed} for completing an entry successfully
  *
  * @category completion
  * @since 2.0.0
@@ -246,6 +283,16 @@ export const failCause = /*#__PURE__*/dual(2, (self, cause) => complete(self, co
 /**
  * Completes a request entry successfully with the supplied value.
  *
+ * **When to use**
+ *
+ * Use to finish a `Request.Entry` when you have a successful value for the
+ * request.
+ *
+ * @see {@link complete} for completing an entry with a prebuilt `Exit`
+ * @see {@link completeEffect} for completing an entry from an effect result
+ * @see {@link fail} for completing an entry with a typed failure
+ * @see {@link failCause} for completing an entry with a failure `Cause`
+ *
  * @category completion
  * @since 2.0.0
  */

package/dist/Request.js.map

@@ -1 +1 @@
-{"version":3,"file":"Request.js","names":["Equal","dual","core","internalEffect","hasProperty","TypeId","requestVariance","byReferenceUnsafe","_E","_","_A","_R","RequestPrototype","StructuralProto","isRequest","u","of","args","Object","assign","create","tagged","tag","request","_tag","Class","prototype","TaggedClass","complete","self","result","sync","completeUnsafe","completeEffect","effect","matchEffect","onFailure","error","exitFail","onSuccess","value","exitSucceed","fail","failCause","cause","exitFailCause","succeed","makeEntry","options"],"sources":["../src/Request.ts"],"sourcesContent":[null],"mappings":"AAkBA,OAAO,KAAKA,KAAK,MAAM,YAAY;AAEnC,SAASC,IAAI,QAAQ,eAAe;AACpC,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,cAAc,MAAM,sBAAsB;AACtD,SAASC,WAAW,QAAQ,gBAAgB;AAG5C,MAAMC,MAAM,GAAG,iBAAiB;AAmKhC,MAAMC,eAAe,gBAAGN,KAAK,CAACO,iBAAiB,CAAC;EAC9C;EACAC,EAAE,EAAGC,CAAQ,IAAKA,CAAC;EACnB;EACAC,EAAE,EAAGD,CAAQ,IAAKA,CAAC;EACnB;EACAE,EAAE,EAAGF,CAAQ,IAAKA;CACnB,CAAC;AAEF;;;;;;;;;;;;;AAaA,OAAO,MAAMG,gBAAgB,GAA2B;EACtD,GAAGV,IAAI,CAACW,eAAe;EACvB,CAACR,MAAM,GAAGC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMQ,SAAS,GAAIC,CAAU,IAA8CX,WAAW,CAACW,CAAC,EAAEV,MAAM,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,MAAMW,EAAE,GAAGA,CAAA,KAAyDC,IAAI,IAC7EC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACR,gBAAgB,CAAC,EAAEK,IAAI,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,OAAO,MAAMI,MAAM,GACjBC,GAAc,IAEfL,IAAI,IAAI;EACP,MAAMM,OAAO,GAAGL,MAAM,CAACE,MAAM,CAACR,gBAAgB,CAAC;EAC/C,IAAIK,IAAI,EAAEC,MAAM,CAACC,MAAM,CAACI,OAAO,EAAEN,IAAI,CAAC;EACtCM,OAAO,CAACC,IAAI,GAAGF,GAAG;EAClB,OAAOC,OAAO;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAME,KAAK,gBAGqC;EACrD,SAASA,KAAKA,CAAYR,IAAS;IACjC,IAAIA,IAAI,EAAE;MACRC,MAAM,CAACC,MAAM,CAAC,IAAI,EAAEF,IAAI,CAAC;IAC3B;EACF;EACAQ,KAAK,CAACC,SAAS,GAAGd,gBAAgB;EAClC,OAAOa,KAAY;AACrB,CAAC,CAAC,CAAE;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAME,WAAW,GACtBL,GAAQ,IAIsE;EAC9E,OAAO,MAAMK,WAAY,SAAQF,KAAoB;IAC1CD,IAAI,GAAGF,GAAG;GACb;AACV,CAAC;AAED;;;;;;;AAOA,OAAO,MAAMM,QAAQ,gBAiBjB3B,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEC,MAAiB,KAC/C3B,cAAc,CAAC4B,IAAI,CAAC,MAAMF,IAAI,CAACG,cAAc,CAACF,MAAM,CAAC,CAAC,CACzD;AAED;;;;;;;;;;;;AAYA,OAAO,MAAMG,cAAc,gBA2BvBhC,IAAI,CACN,CAAC,EACD,CAAmB4B,IAAc,EAAEK,MAA8C,KAC/E/B,cAAc,CAACgC,WAAW,CAACD,MAAM,EAAE;EACjCE,SAAS,EAAGC,KAAK,IAAKT,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACoC,QAAQ,CAACD,KAAK,CAAQ,CAAC;EACjEE,SAAS,EAAGC,KAAK,IAAKZ,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACuC,WAAW,CAACD,KAAK,CAAQ;CACpE,CAAC,CACL;AAED;;;;;;AAMA,OAAO,MAAME,IAAI,gBAebzC,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEQ,KAAe,KAA0BT,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACoC,QAAQ,CAACD,KAAK,CAAQ,CAAC,CACrH;AAED;;;;;;;;;;;AAWA,OAAO,MAAMM,SAAS,gBAyBlB1C,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEe,KAA4B,KAC1DhB,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAAC2C,aAAa,CAACD,KAAK,CAAQ,CAAC,CACnD;AAED;;;;;;AAMA,OAAO,MAAME,OAAO,gBAehB7C,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEW,KAAiB,KAC/CZ,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACuC,WAAW,CAACD,KAAK,CAAQ,CAAC,CACjD;AA4BD;;;;;;;;;;;;AAYA,OAAO,MAAMO,SAAS,GAAOC,OAY5B,IAAeA,OAAO","ignoreList":[]}
+{"version":3,"file":"Request.js","names":["Equal","dual","core","internalEffect","hasProperty","TypeId","requestVariance","byReferenceUnsafe","_E","_","_A","_R","RequestPrototype","StructuralProto","isRequest","u","of","args","Object","assign","create","tagged","tag","request","_tag","Class","prototype","TaggedClass","complete","self","result","sync","completeUnsafe","completeEffect","effect","matchEffect","onFailure","error","exitFail","onSuccess","value","exitSucceed","fail","failCause","cause","exitFailCause","succeed","makeEntry","options"],"sources":["../src/Request.ts"],"sourcesContent":[null],"mappings":"AAiDA,OAAO,KAAKA,KAAK,MAAM,YAAY;AAEnC,SAASC,IAAI,QAAQ,eAAe;AACpC,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,cAAc,MAAM,sBAAsB;AACtD,SAASC,WAAW,QAAQ,gBAAgB;AAG5C,MAAMC,MAAM,GAAG,iBAAiB;AA8KhC,MAAMC,eAAe,gBAAGN,KAAK,CAACO,iBAAiB,CAAC;EAC9C;EACAC,EAAE,EAAGC,CAAQ,IAAKA,CAAC;EACnB;EACAC,EAAE,EAAGD,CAAQ,IAAKA,CAAC;EACnB;EACAE,EAAE,EAAGF,CAAQ,IAAKA;CACnB,CAAC;AAEF;;;;;;;;;;;;;AAaA,OAAO,MAAMG,gBAAgB,GAA2B;EACtD,GAAGV,IAAI,CAACW,eAAe;EACvB,CAACR,MAAM,GAAGC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMQ,SAAS,GAAIC,CAAU,IAA8CX,WAAW,CAACW,CAAC,EAAEV,MAAM,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,MAAMW,EAAE,GAAGA,CAAA,KAAyDC,IAAI,IAC7EC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACR,gBAAgB,CAAC,EAAEK,IAAI,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,OAAO,MAAMI,MAAM,GACjBC,GAAc,IAEfL,IAAI,IAAI;EACP,MAAMM,OAAO,GAAGL,MAAM,CAACE,MAAM,CAACR,gBAAgB,CAAC;EAC/C,IAAIK,IAAI,EAAEC,MAAM,CAACC,MAAM,CAACI,OAAO,EAAEN,IAAI,CAAC;EACtCM,OAAO,CAACC,IAAI,GAAGF,GAAG;EAClB,OAAOC,OAAO;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAME,KAAK,gBAGqC;EACrD,SAASA,KAAKA,CAAYR,IAAS;IACjC,IAAIA,IAAI,EAAE;MACRC,MAAM,CAACC,MAAM,CAAC,IAAI,EAAEF,IAAI,CAAC;IAC3B;EACF;EACAQ,KAAK,CAACC,SAAS,GAAGd,gBAAgB;EAClC,OAAOa,KAAY;AACrB,CAAC,CAAC,CAAE;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAME,WAAW,GACtBL,GAAQ,IAIsE;EAC9E,OAAO,MAAMK,WAAY,SAAQF,KAAoB;IAC1CD,IAAI,GAAGF,GAAG;GACb;AACV,CAAC;AAED;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMM,QAAQ,gBAmCjB3B,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEC,MAAiB,KAC/C3B,cAAc,CAAC4B,IAAI,CAAC,MAAMF,IAAI,CAACG,cAAc,CAACF,MAAM,CAAC,CAAC,CACzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMG,cAAc,gBAqDvBhC,IAAI,CACN,CAAC,EACD,CAAmB4B,IAAc,EAAEK,MAA8C,KAC/E/B,cAAc,CAACgC,WAAW,CAACD,MAAM,EAAE;EACjCE,SAAS,EAAGC,KAAK,IAAKT,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACoC,QAAQ,CAACD,KAAK,CAAQ,CAAC;EACjEE,SAAS,EAAGC,KAAK,IAAKZ,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACuC,WAAW,CAACD,KAAK,CAAQ;CACpE,CAAC,CACL;AAED;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAME,IAAI,gBAmCbzC,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEQ,KAAe,KAA0BT,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACoC,QAAQ,CAACD,KAAK,CAAQ,CAAC,CACrH;AAED;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMM,SAAS,gBAmClB1C,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEe,KAA4B,KAC1DhB,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAAC2C,aAAa,CAACD,KAAK,CAAQ,CAAC,CACnD;AAED;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAME,OAAO,gBAmChB7C,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEW,KAAiB,KAC/CZ,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACuC,WAAW,CAACD,KAAK,CAAQ,CAAC,CACjD;AA4BD;;;;;;;;;;;;AAYA,OAAO,MAAMO,SAAS,GAAOC,OAY5B,IAAeA,OAAO","ignoreList":[]}