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

package/dist/Request.d.ts

@@ -23,7 +23,8 @@ declare const TypeId = "~effect/Request";
  * A `Request<A, E, R>` is a request from a data source for a value of type `A`
  * that may fail with an `E` and have requirements of type `R`.
  *
- * @example
+ * **Example** (Defining typed requests)
+ *
  * ```ts
  * import type { Request } from "effect"
  *
@@ -39,19 +40,29 @@ declare const TypeId = "~effect/Request";
  * }
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface Request<out A, out E = never, out R = never> extends Variance<A, E, R> {
 }
 /**
- * @since 2.0.0
+ * Alias for any `Request`, regardless of its success, error, or service
+ * requirements.
+ *
  * @category models
+ * @since 2.0.0
  */
 export type Any = Request<any, any, any>;
 /**
- * @since 2.0.0
+ * Variance marker carried by every `Request`.
+ *
+ * **Notes**
+ *
+ * This marker preserves the success, error, and service requirement types for
+ * Effect's type-level machinery. Users normally get it by extending `Request`.
+ *
  * @category models
+ * @since 2.0.0
  */
 export interface Variance<out A, out E, out R> {
     readonly [TypeId]: {
@@ -61,7 +72,16 @@ export interface Variance<out A, out E, out R> {
     };
 }
 /**
- * @example
+ * The constructor type returned by `Request.of` and `Request.tagged`.
+ *
+ * **Details**
+ *
+ * The constructor accepts the request's data fields, excluding request variance
+ * fields and any fields already supplied by the constructor such as `_tag`, and
+ * returns a value of the request type.
+ *
+ * **Example** (Using generated request constructors)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -75,8 +95,8 @@ export interface Variance<out A, out E, out R> {
  * const userRequest = GetUser({ id: 123 })
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface Constructor<R extends Request<any, any, any>, T extends keyof R = never> {
     (args: Types.VoidIfEmpty<Types.Simplify<Omit<R, T | keyof (Variance<any, any, any>)>>>): R;
@@ -84,7 +104,8 @@ export interface Constructor<R extends Request<any, any, any>, T extends keyof R
 /**
  * A utility type to extract the error type from a `Request`.
  *
- * @example
+ * **Example** (Extracting a request error type)
+ *
  * ```ts
  * import type { Request } from "effect"
  *
@@ -96,14 +117,15 @@ export interface Constructor<R extends Request<any, any, any>, T extends keyof R
  * type UserError = Request.Error<GetUser> // Error
  * ```
  *
- * @since 2.0.0
  * @category type-level
+ * @since 2.0.0
  */
 export type Error<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _E : never;
 /**
  * A utility type to extract the value type from a `Request`.
  *
- * @example
+ * **Example** (Extracting a request success type)
+ *
  * ```ts
  * import type { Request } from "effect"
  *
@@ -116,21 +138,22 @@ export type Error<T extends Request<any, any, any>> = [T] extends [Request<infer
  * type UserSuccess = Request.Success<GetUser> // string
  * ```
  *
- * @since 2.0.0
  * @category type-level
+ * @since 2.0.0
  */
 export type Success<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _A : never;
 /**
  * A utility type to extract the requirements type from a `Request`.
  *
- * @since 4.0.0
  * @category type-level
+ * @since 4.0.0
  */
 export type Services<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _R : never;
 /**
  * A utility type to extract the result type from a `Request`.
  *
- * @example
+ * **Example** (Extracting a request result type)
+ *
  * ```ts
  * import type { Request } from "effect"
  *
@@ -143,18 +166,28 @@ export type Services<T extends Request<any, any, any>> = [T] extends [Request<in
  * type UserResult = Request.Result<GetUser> // Exit.Exit<string, Error>
  * ```
  *
- * @since 2.0.0
  * @category type-level
+ * @since 2.0.0
  */
 export type Result<T extends Request<any, any, any>> = T extends Request<infer A, infer E, infer _R> ? Exit.Exit<A, E> : never;
 /**
+ * Prototype used by Effect's request constructors.
+ *
+ * **Notes**
+ *
+ * This low-level value provides the structural request marker for values
+ * created by `Request.of`, `Request.tagged`, `Request.Class`, and
+ * `Request.TaggedClass`. Most users should use those constructors instead of
+ * interacting with the prototype directly.
+ *
  * @since 4.0.0
  */
 export declare const RequestPrototype: Request<any, any, any>;
 /**
  * Tests if a value is a `Request`.
  *
- * @example
+ * **Example** (Checking request values)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -181,7 +214,8 @@ export declare const isRequest: (u: unknown) => u is Request<unknown, unknown, u
 /**
  * Creates a constructor function for a specific Request type.
  *
- * @example
+ * **Example** (Creating untagged request constructors)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -211,7 +245,8 @@ export declare const of: <R extends Request<any, any, any>>() => Constructor<R>;
  * Creates a constructor function for a tagged Request type. The tag is automatically
  * added to the request, making it useful for discriminated unions.
  *
- * @example
+ * **Example** (Creating tagged request constructors)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -252,7 +287,15 @@ export declare const tagged: <R extends Request<any, any, any> & {
     _tag: string;
 }>(tag: R["_tag"]) => Constructor<R, "_tag">;
 /**
- * @example
+ * Base class constructor for defining request types with TypeScript classes.
+ *
+ * **Details**
+ *
+ * Subclasses pass their data fields to `super`, and instances are marked as
+ * `Request` values while retaining the provided readonly fields.
+ *
+ * **Example** (Defining request classes)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -266,14 +309,22 @@ export declare const tagged: <R extends Request<any, any, any> & {
  * console.log(getUserRequest.id) // 123
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const Class: new <A extends Record<string, any>, Success, Error = never, Context = never>(args: Types.Equals<Omit<A, keyof Request<unknown, unknown>>, {}> extends true ? void : {
     readonly [P in keyof A as P extends keyof Request<any, any, any> ? never : P]: A[P];
 }) => Request<Success, Error, Context> & Readonly<A>;
 /**
- * @example
+ * Creates a class constructor for requests with a fixed `_tag` field.
+ *
+ * **Details**
+ *
+ * Use this when defining class-based request types that should participate in
+ * tagged unions or tag-based request resolvers.
+ *
+ * **Example** (Defining tagged request classes)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -286,8 +337,8 @@ export declare const Class: new <A extends Record<string, any>, Success, Error =
  * console.log(request.id) // 123
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const TaggedClass: <Tag extends string>(tag: Tag) => new <A extends Record<string, any>, Success, Error = never, Services = never>(args: Types.Equals<Omit<A, keyof Request<unknown, unknown>>, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" | keyof Request<any, any, any> ? never : P]: A[P]; }) => Request<Success, Error, Services> & Readonly<A> & {
     readonly _tag: Tag;
@@ -318,72 +369,137 @@ export declare const complete: {
     <A extends Any>(self: Entry<A>, result: Result<A>): Effect.Effect<void>;
 };
 /**
- * @since 2.0.0
+ * Completes a request entry with the result of an effect.
+ *
+ * **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.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export declare const completeEffect: {
     /**
-     * @since 2.0.0
+     * Completes a request entry with the result of an effect.
+     *
+     * **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.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any, R>(effect: Effect.Effect<Success<A>, Error<A>, R>): (self: Entry<A>) => Effect.Effect<void, never, R>;
     /**
-     * @since 2.0.0
+     * Completes a request entry with the result of an effect.
+     *
+     * **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.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any, R>(self: Entry<A>, effect: Effect.Effect<Success<A>, Error<A>, R>): Effect.Effect<void, never, R>;
 };
 /**
- * @since 2.0.0
+ * Completes a request entry with a typed failure.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export declare const fail: {
     /**
-     * @since 2.0.0
+     * Completes a request entry with a typed failure.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any>(error: Error<A>): (self: Entry<A>) => Effect.Effect<void>;
     /**
-     * @since 2.0.0
+     * Completes a request entry with a typed failure.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any>(self: Entry<A>, error: Error<A>): Effect.Effect<void>;
 };
 /**
- * @since 2.0.0
+ * Completes a request entry with a failure `Cause`.
+ *
+ * **Details**
+ *
+ * Use this when the request should fail with structured cause information
+ * rather than only the request's typed error value.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export declare const failCause: {
     /**
-     * @since 2.0.0
+     * Completes a request entry with a failure `Cause`.
+     *
+     * **Details**
+     *
+     * Use this when the request should fail with structured cause information
+     * rather than only the request's typed error value.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any>(cause: Cause.Cause<Error<A>>): (self: Entry<A>) => Effect.Effect<void>;
     /**
-     * @since 2.0.0
+     * Completes a request entry with a failure `Cause`.
+     *
+     * **Details**
+     *
+     * Use this when the request should fail with structured cause information
+     * rather than only the request's typed error value.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any>(self: Entry<A>, cause: Cause.Cause<Error<A>>): Effect.Effect<void>;
 };
 /**
- * @since 2.0.0
+ * Completes a request entry successfully with the supplied value.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export declare const succeed: {
     /**
-     * @since 2.0.0
+     * Completes a request entry successfully with the supplied value.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any>(value: Success<A>): (self: Entry<A>) => Effect.Effect<void>;
     /**
-     * @since 2.0.0
+     * Completes a request entry successfully with the supplied value.
+     *
      * @category completion
+     * @since 2.0.0
      */
     <A extends Any>(self: Entry<A>, value: Success<A>): Effect.Effect<void>;
 };
 /**
- * @since 2.0.0
+ * A pending request handed to a `RequestResolver`.
+ *
+ * **Details**
+ *
+ * An entry contains the original request, the fiber context needed to run it,
+ * an `uninterruptible` flag used by batching and caching internals, and the
+ * `completeUnsafe` callback used by resolvers to supply the final `Exit`.
+ *
  * @category entry
+ * @since 2.0.0
  */
 export interface Entry<out R> {
     readonly request: R;
@@ -398,8 +514,16 @@ export interface Entry<out R> {
     ] extends [Request<infer _A, infer _E, infer _R>] ? _E : never>): void;
 }
 /**
- * @since 2.0.0
+ * Creates a `Request.Entry` from its component fields.
+ *
+ * **Notes**
+ *
+ * This is a low-level helper for request runtime and resolver infrastructure;
+ * most application code receives entries from a `RequestResolver` instead of
+ * constructing them directly.
+ *
  * @category entry
+ * @since 2.0.0
  */
 export declare const makeEntry: <R>(options: {
     readonly request: R;

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;;;;;;;;;;;;;;;;;;;;;;GAsBG;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;;;GAGG;AACH,MAAM,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AAExC;;;GAGG;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;;;;;;;;;;;;;;;;;GAiBG;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;;;;;;;;;;;;;;;;;GAiBG;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;;;;;;;;;;;;;;;;;;GAkBG;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;;;;;;;;;;;;;;;;;;GAkBG;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;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAGnD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,SAAS,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAA2B,CAAA;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,OAAK,WAAW,CAAC,CAAC,CACf,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;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;;;;;;;;;;;;;;;;;GAiBG;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;;;;;;;;;;;;;;;;GAgBG;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;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE;IAC3B;;;OAGG;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;;;OAGG;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;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;OAGG;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;;;OAGG;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;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE;IACtB;;;OAGG;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;;;OAGG;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;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;OAGG;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;;;OAGG;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;;;GAGG;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;;;GAGG;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;;;;;;;;;;;;;;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;;;;;;;;;;;GAWG;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"}

package/dist/Request.js

@@ -13,6 +13,15 @@ const requestVariance = /*#__PURE__*/Equal.byReferenceUnsafe({
   _R: _ => _
 });
 /**
+ * Prototype used by Effect's request constructors.
+ *
+ * **Notes**
+ *
+ * This low-level value provides the structural request marker for values
+ * created by `Request.of`, `Request.tagged`, `Request.Class`, and
+ * `Request.TaggedClass`. Most users should use those constructors instead of
+ * interacting with the prototype directly.
+ *
  * @since 4.0.0
  */
 export const RequestPrototype = {
@@ -22,7 +31,8 @@ export const RequestPrototype = {
 /**
  * Tests if a value is a `Request`.
  *
- * @example
+ * **Example** (Checking request values)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -49,7 +59,8 @@ export const isRequest = u => hasProperty(u, TypeId);
 /**
  * Creates a constructor function for a specific Request type.
  *
- * @example
+ * **Example** (Creating untagged request constructors)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -79,7 +90,8 @@ export const of = () => args => Object.assign(Object.create(RequestPrototype), a
  * Creates a constructor function for a tagged Request type. The tag is automatically
  * added to the request, making it useful for discriminated unions.
  *
- * @example
+ * **Example** (Creating tagged request constructors)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -123,7 +135,15 @@ export const tagged = tag => args => {
   return request;
 };
 /**
- * @example
+ * Base class constructor for defining request types with TypeScript classes.
+ *
+ * **Details**
+ *
+ * Subclasses pass their data fields to `super`, and instances are marked as
+ * `Request` values while retaining the provided readonly fields.
+ *
+ * **Example** (Defining request classes)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -137,8 +157,8 @@ export const tagged = tag => args => {
  * console.log(getUserRequest.id) // 123
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export const Class = /*#__PURE__*/function () {
   function Class(args) {
@@ -150,7 +170,15 @@ export const Class = /*#__PURE__*/function () {
   return Class;
 }();
 /**
- * @example
+ * Creates a class constructor for requests with a fixed `_tag` field.
+ *
+ * **Details**
+ *
+ * Use this when defining class-based request types that should participate in
+ * tagged unions or tag-based request resolvers.
+ *
+ * **Example** (Defining tagged request classes)
+ *
  * ```ts
  * import { Request } from "effect"
  *
@@ -163,8 +191,8 @@ export const Class = /*#__PURE__*/function () {
  * console.log(request.id) // 123
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export const TaggedClass = tag => {
   return class TaggedClass extends Class {
@@ -180,31 +208,58 @@ export const TaggedClass = tag => {
  */
 export const complete = /*#__PURE__*/dual(2, (self, result) => internalEffect.sync(() => self.completeUnsafe(result)));
 /**
- * @since 2.0.0
+ * Completes a request entry with the result of an effect.
+ *
+ * **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.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export const completeEffect = /*#__PURE__*/dual(2, (self, effect) => internalEffect.matchEffect(effect, {
   onFailure: error => complete(self, core.exitFail(error)),
   onSuccess: value => complete(self, core.exitSucceed(value))
 }));
 /**
- * @since 2.0.0
+ * Completes a request entry with a typed failure.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export const fail = /*#__PURE__*/dual(2, (self, error) => complete(self, core.exitFail(error)));
 /**
- * @since 2.0.0
+ * Completes a request entry with a failure `Cause`.
+ *
+ * **Details**
+ *
+ * Use this when the request should fail with structured cause information
+ * rather than only the request's typed error value.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export const failCause = /*#__PURE__*/dual(2, (self, cause) => complete(self, core.exitFailCause(cause)));
 /**
- * @since 2.0.0
+ * Completes a request entry successfully with the supplied value.
+ *
  * @category completion
+ * @since 2.0.0
  */
 export const succeed = /*#__PURE__*/dual(2, (self, value) => complete(self, core.exitSucceed(value)));
 /**
- * @since 2.0.0
+ * Creates a `Request.Entry` from its component fields.
+ *
+ * **Notes**
+ *
+ * This is a low-level helper for request runtime and resolver infrastructure;
+ * most application code receives entries from a `RequestResolver` instead of
+ * constructing them directly.
+ *
  * @category entry
+ * @since 2.0.0
  */
 export const makeEntry = options => options;
 //# sourceMappingURL=Request.js.map

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;AA4IhC,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;;;AAGA,OAAO,MAAMG,gBAAgB,GAA2B;EACtD,GAAGV,IAAI,CAACW,eAAe;EACvB,CAACR,MAAM,GAAGC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAMQ,SAAS,GAAIC,CAAU,IAA8CX,WAAW,CAACW,CAAC,EAAEV,MAAM,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAMW,EAAE,GAAGA,CAAA,KAAyDC,IAAI,IAC7EC,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACR,gBAAgB,CAAC,EAAEK,IAAI,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,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;;;;;;;;;;;;;;;;;;AAkBA,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;;;;;;;;;;;;;;;;;AAiBA,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;;;;AAIA,OAAO,MAAMG,cAAc,gBAWvBhC,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;;;;AAIA,OAAO,MAAME,IAAI,gBAWbzC,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEQ,KAAe,KAA0BT,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACoC,QAAQ,CAACD,KAAK,CAAQ,CAAC,CACrH;AAED;;;;AAIA,OAAO,MAAMM,SAAS,gBAWlB1C,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEe,KAA4B,KAC1DhB,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAAC2C,aAAa,CAACD,KAAK,CAAQ,CAAC,CACnD;AAED;;;;AAIA,OAAO,MAAME,OAAO,gBAWhB7C,IAAI,CACN,CAAC,EACD,CAAgB4B,IAAc,EAAEW,KAAiB,KAC/CZ,QAAQ,CAACC,IAAI,EAAE3B,IAAI,CAACuC,WAAW,CAACD,KAAK,CAAQ,CAAC,CACjD;AAoBD;;;;AAIA,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":"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;;;;;;;;;;;;AAYA,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":[]}