effect 4.0.0-beta.65 → 4.0.0-beta.67

package/dist/unstable/http/HttpClientError.d.ts

@@ -3,16 +3,20 @@ import type * as HttpClientRequest from "./HttpClientRequest.ts";
 import type * as ClientResponse from "./HttpClientResponse.ts";
 declare const TypeId = "~effect/http/HttpClientError";
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an `HttpClientError`.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export declare const isHttpClientError: (u: unknown) => u is HttpClientError;
 declare const HttpClientError_base: new <A extends Record<string, any> = {}>(args: import("../../Types.ts").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("../../Cause.ts").YieldableError & {
     readonly _tag: "HttpClientError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Error wrapper for HTTP client failures, exposing the failed request and the optional response through its `reason`.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class HttpClientError extends HttpClientError_base<{
     readonly reason: HttpClientErrorReason;
@@ -21,14 +25,20 @@ export declare class HttpClientError extends HttpClientError_base<{
         readonly reason: HttpClientErrorReason;
     });
     /**
+     * Marks this value as an HTTP client error for runtime guards.
+     *
      * @since 4.0.0
      */
     readonly [TypeId] = "~effect/http/HttpClientError";
     /**
+     * HTTP request associated with the client failure.
+     *
      * @since 4.0.0
      */
     get request(): HttpClientRequest.HttpClientRequest;
     /**
+     * HTTP response associated with the client failure, when one was received.
+     *
      * @since 4.0.0
      */
     get response(): ClientResponse.HttpClientResponse | undefined;
@@ -38,8 +48,10 @@ declare const TransportError_base: new <A extends Record<string, any> = {}>(args
     readonly _tag: "TransportError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Request error for transport-level failures that occur while sending an HTTP request.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class TransportError extends TransportError_base<{
     readonly request: HttpClientRequest.HttpClientRequest;
@@ -47,10 +59,14 @@ export declare class TransportError extends TransportError_base<{
     readonly description?: string;
 }> {
     /**
+     * Formats the request method and URL for transport error messages.
+     *
      * @since 4.0.0
      */
     get methodAndUrl(): string;
     /**
+     * Builds the transport error message from the optional description and request details.
+     *
      * @since 4.0.0
      */
     get message(): string;
@@ -59,8 +75,10 @@ declare const EncodeError_base: new <A extends Record<string, any> = {}>(args: i
     readonly _tag: "EncodeError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Request error for failures while encoding an HTTP request body.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class EncodeError extends EncodeError_base<{
     readonly request: HttpClientRequest.HttpClientRequest;
@@ -68,10 +86,14 @@ export declare class EncodeError extends EncodeError_base<{
     readonly description?: string;
 }> {
     /**
+     * Formats the request method and URL for request encoding error messages.
+     *
      * @since 4.0.0
      */
     get methodAndUrl(): string;
     /**
+     * Builds the request encoding error message from the optional description and request details.
+     *
      * @since 4.0.0
      */
     get message(): string;
@@ -80,8 +102,10 @@ declare const InvalidUrlError_base: new <A extends Record<string, any> = {}>(arg
     readonly _tag: "InvalidUrlError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Request error for failures while constructing a URL from an HTTP client request.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class InvalidUrlError extends InvalidUrlError_base<{
     readonly request: HttpClientRequest.HttpClientRequest;
@@ -89,10 +113,14 @@ export declare class InvalidUrlError extends InvalidUrlError_base<{
     readonly description?: string;
 }> {
     /**
+     * Formats the request method and URL for invalid URL error messages.
+     *
      * @since 4.0.0
      */
     get methodAndUrl(): string;
     /**
+     * Builds the invalid URL error message from the optional description and request details.
+     *
      * @since 4.0.0
      */
     get message(): string;
@@ -101,8 +129,10 @@ declare const StatusCodeError_base: new <A extends Record<string, any> = {}>(arg
     readonly _tag: "StatusCodeError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Response error for HTTP responses rejected because of their status code.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class StatusCodeError extends StatusCodeError_base<{
     readonly request: HttpClientRequest.HttpClientRequest;
@@ -111,10 +141,14 @@ export declare class StatusCodeError extends StatusCodeError_base<{
     readonly description?: string | undefined;
 }> {
     /**
+     * Formats the request method and URL for status code error messages.
+     *
      * @since 4.0.0
      */
     get methodAndUrl(): string;
     /**
+     * Builds the status code error message from the response status, optional description, and request details.
+     *
      * @since 4.0.0
      */
     get message(): string;
@@ -123,8 +157,10 @@ declare const DecodeError_base: new <A extends Record<string, any> = {}>(args: i
     readonly _tag: "DecodeError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Response error for failures while decoding an HTTP response body.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class DecodeError extends DecodeError_base<{
     readonly request: HttpClientRequest.HttpClientRequest;
@@ -133,10 +169,14 @@ export declare class DecodeError extends DecodeError_base<{
     readonly description?: string | undefined;
 }> {
     /**
+     * Formats the request method and URL for response decoding error messages.
+     *
      * @since 4.0.0
      */
     get methodAndUrl(): string;
     /**
+     * Builds the response decoding error message from the response status, optional description, and request details.
+     *
      * @since 4.0.0
      */
     get message(): string;
@@ -145,8 +185,10 @@ declare const EmptyBodyError_base: new <A extends Record<string, any> = {}>(args
     readonly _tag: "EmptyBodyError";
 } & Readonly<A>;
 /**
- * @since 4.0.0
+ * Response error for operations that expected a response body but received an empty body.
+ *
  * @category error
+ * @since 4.0.0
  */
 export declare class EmptyBodyError extends EmptyBodyError_base<{
     readonly request: HttpClientRequest.HttpClientRequest;
@@ -155,27 +197,37 @@ export declare class EmptyBodyError extends EmptyBodyError_base<{
     readonly description?: string | undefined;
 }> {
     /**
+     * Formats the request method and URL for empty response body error messages.
+     *
      * @since 4.0.0
      */
     get methodAndUrl(): string;
     /**
+     * Builds the empty body error message from the response status, optional description, and request details.
+     *
      * @since 4.0.0
      */
     get message(): string;
 }
 /**
- * @since 4.0.0
+ * Union of HTTP client errors that occur before a response is available.
+ *
  * @category error
+ * @since 4.0.0
  */
 export type RequestError = TransportError | EncodeError | InvalidUrlError;
 /**
- * @since 4.0.0
+ * Union of HTTP client errors that include an HTTP response.
+ *
  * @category error
+ * @since 4.0.0
  */
 export type ResponseError = StatusCodeError | DecodeError | EmptyBodyError;
 /**
- * @since 4.0.0
+ * Union of all specific failure reasons carried by `HttpClientError`.
+ *
  * @category error
+ * @since 4.0.0
  */
 export type HttpClientErrorReason = RequestError | ResponseError;
 declare const HttpClientErrorSchema_base: Schema.Class<HttpClientErrorSchema, Schema.Struct<{
@@ -184,11 +236,15 @@ declare const HttpClientErrorSchema_base: Schema.Class<HttpClientErrorSchema, Sc
     readonly cause: Schema.optional<Schema.Defect>;
 }>, import("../../Cause.ts").YieldableError>;
 /**
- * @since 4.0.0
+ * Serializable schema representation of an `HttpClientError`, preserving the specific error kind and cause.
+ *
  * @category Schema
+ * @since 4.0.0
  */
 export declare class HttpClientErrorSchema extends HttpClientErrorSchema_base {
     /**
+     * Builds the serializable schema representation for an HTTP client error.
+     *
      * @since 4.0.0
      */
     static fromHttpClientError(error: HttpClientError): HttpClientErrorSchema;

package/dist/unstable/http/HttpClientError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpClientError.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpClientError.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,KAAK,cAAc,MAAM,yBAAyB,CAAA;AAE9D,QAAA,MAAM,MAAM,iCAAiC,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,eAAyC,CAAA;;;;AAE7F;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;CACvC,CAAC;gBACY,KAAK,EAAE;QACjB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;KACvC;IAWD;;OAEG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,kCAAS;IAE1B;;OAEG;IACH,IAAI,OAAO,IAAI,iBAAiB,CAAC,iBAAiB,CAEjD;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,cAAc,CAAC,kBAAkB,GAAG,SAAS,CAE5D;IAED,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;AAOD;;;GAGG;AACH,qBAAa,cAAe,SAAQ,oBAAmC;IACrE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAC;IACA;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAa,OAAO,WAEnB;CACF;;;;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,iBAAgC;IAC/D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAC;IACA;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAa,OAAO,WAEnB;CACF;;;;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAC;IACA;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAa,OAAO,WAEnB;CACF;;;;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,kBAAkB,CAAA;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAC;IACA;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAa,OAAO,WAGnB;CACF;;;;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,iBAAgC;IAC/D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,kBAAkB,CAAA;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAC;IACA;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAa,OAAO,WAGnB;CACF;;;;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,oBAAmC;IACrE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,kBAAkB,CAAA;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAC;IACA;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAa,OAAO,WAGnB;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,WAAW,GAAG,eAAe,CAAA;AAEzE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG,WAAW,GAAG,cAAc,CAAA;AAE1E;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,aAAa,CAAA;;;;;;AAEhE;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,0BAazC;IACA;;OAEG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,eAAe,GAAG,qBAAqB;CAO1E"}
+{"version":3,"file":"HttpClientError.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpClientError.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,KAAK,cAAc,MAAM,yBAAyB,CAAA;AAE9D,QAAA,MAAM,MAAM,iCAAiC,CAAA;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,eAAyC,CAAA;;;;AAE7F;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;CACvC,CAAC;gBACY,KAAK,EAAE;QACjB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;KACvC;IAWD;;;;OAIG;IACH,QAAQ,CAAC,CAAC,MAAM,CAAC,kCAAS;IAE1B;;;;OAIG;IACH,IAAI,OAAO,IAAI,iBAAiB,CAAC,iBAAiB,CAEjD;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,cAAc,CAAC,kBAAkB,GAAG,SAAS,CAE5D;IAED,IAAa,OAAO,IAAI,MAAM,CAE7B;CACF;;;;AAOD;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,oBAAmC;IACrE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAC;IACA;;;;OAIG;IACH,IAAI,YAAY,WAEf;IAED;;;;OAIG;IACH,IAAa,OAAO,WAEnB;CACF;;;;AAED;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,iBAAgC;IAC/D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAC;IACA;;;;OAIG;IACH,IAAI,YAAY,WAEf;IAED;;;;OAIG;IACH,IAAa,OAAO,WAEnB;CACF;;;;AAED;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAC;IACA;;;;OAIG;IACH,IAAI,YAAY,WAEf;IAED;;;;OAIG;IACH,IAAa,OAAO,WAEnB;CACF;;;;AAED;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,qBAAoC;IACvE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,kBAAkB,CAAA;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAC;IACA;;;;OAIG;IACH,IAAI,YAAY,WAEf;IAED;;;;OAIG;IACH,IAAa,OAAO,WAGnB;CACF;;;;AAED;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,iBAAgC;IAC/D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,kBAAkB,CAAA;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAC;IACA;;;;OAIG;IACH,IAAI,YAAY,WAEf;IAED;;;;OAIG;IACH,IAAa,OAAO,WAGnB;CACF;;;;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,oBAAmC;IACrE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,kBAAkB,CAAA;IACpD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAC;IACA;;;;OAIG;IACH,IAAI,YAAY,WAEf;IAED;;;;OAIG;IACH,IAAa,OAAO,WAGnB;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,WAAW,GAAG,eAAe,CAAA;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG,WAAW,GAAG,cAAc,CAAA;AAE1E;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,aAAa,CAAA;;;;;;AAEhE;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,0BAazC;IACA;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,eAAe,GAAG,qBAAqB;CAO1E"}

package/dist/unstable/http/HttpClientError.js

@@ -1,4 +1,16 @@
 /**
+ * Error types used by the HTTP client to describe failures that occur while
+ * preparing requests, sending them, validating response status codes, and
+ * decoding response bodies.
+ *
+ * The module exposes the `HttpClientError` wrapper together with the specific
+ * reason classes it can carry, so applications can either handle all HTTP
+ * client failures uniformly or branch on the exact `_tag` for retries, logging,
+ * metrics, and user-facing messages. A common gotcha is that only response
+ * errors carry an `HttpClientResponse`: transport, encoding, and invalid URL
+ * failures happen before a response is available, while status-code, decode, and
+ * empty-body failures preserve the response that triggered them.
+ *
  * @since 4.0.0
  */
 import * as Data from "../../Data.js";
@@ -6,13 +18,17 @@ import { hasProperty } from "../../Predicate.js";
 import * as Schema from "../../Schema.js";
 const TypeId = "~effect/http/HttpClientError";
 /**
- * @since 4.0.0
+ * Returns `true` when a value is an `HttpClientError`.
+ *
  * @category guards
+ * @since 4.0.0
  */
 export const isHttpClientError = u => hasProperty(u, TypeId);
 /**
- * @since 4.0.0
+ * Error wrapper for HTTP client failures, exposing the failed request and the optional response through its `reason`.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class HttpClientError extends /*#__PURE__*/Data.TaggedError("HttpClientError") {
   constructor(props) {
@@ -26,16 +42,22 @@ export class HttpClientError extends /*#__PURE__*/Data.TaggedError("HttpClientEr
     }
   }
   /**
+   * Marks this value as an HTTP client error for runtime guards.
+   *
    * @since 4.0.0
    */
   [TypeId] = TypeId;
   /**
+   * HTTP request associated with the client failure.
+   *
    * @since 4.0.0
    */
   get request() {
     return this.reason.request;
   }
   /**
+   * HTTP response associated with the client failure, when one was received.
+   *
    * @since 4.0.0
    */
   get response() {
@@ -48,17 +70,23 @@ export class HttpClientError extends /*#__PURE__*/Data.TaggedError("HttpClientEr
 const formatReason = tag => tag.endsWith("Error") ? tag.slice(0, -5) : tag;
 const formatMessage = (reason, description, info) => description ? `${reason}: ${description} (${info})` : `${reason} error (${info})`;
 /**
- * @since 4.0.0
+ * Request error for transport-level failures that occur while sending an HTTP request.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class TransportError extends /*#__PURE__*/Data.TaggedError("TransportError") {
   /**
+   * Formats the request method and URL for transport error messages.
+   *
    * @since 4.0.0
    */
   get methodAndUrl() {
     return `${this.request.method} ${this.request.url}`;
   }
   /**
+   * Builds the transport error message from the optional description and request details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -66,17 +94,23 @@ export class TransportError extends /*#__PURE__*/Data.TaggedError("TransportErro
   }
 }
 /**
- * @since 4.0.0
+ * Request error for failures while encoding an HTTP request body.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class EncodeError extends /*#__PURE__*/Data.TaggedError("EncodeError") {
   /**
+   * Formats the request method and URL for request encoding error messages.
+   *
    * @since 4.0.0
    */
   get methodAndUrl() {
     return `${this.request.method} ${this.request.url}`;
   }
   /**
+   * Builds the request encoding error message from the optional description and request details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -84,17 +118,23 @@ export class EncodeError extends /*#__PURE__*/Data.TaggedError("EncodeError") {
   }
 }
 /**
- * @since 4.0.0
+ * Request error for failures while constructing a URL from an HTTP client request.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class InvalidUrlError extends /*#__PURE__*/Data.TaggedError("InvalidUrlError") {
   /**
+   * Formats the request method and URL for invalid URL error messages.
+   *
    * @since 4.0.0
    */
   get methodAndUrl() {
     return `${this.request.method} ${this.request.url}`;
   }
   /**
+   * Builds the invalid URL error message from the optional description and request details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -102,17 +142,23 @@ export class InvalidUrlError extends /*#__PURE__*/Data.TaggedError("InvalidUrlEr
   }
 }
 /**
- * @since 4.0.0
+ * Response error for HTTP responses rejected because of their status code.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class StatusCodeError extends /*#__PURE__*/Data.TaggedError("StatusCodeError") {
   /**
+   * Formats the request method and URL for status code error messages.
+   *
    * @since 4.0.0
    */
   get methodAndUrl() {
     return `${this.request.method} ${this.request.url}`;
   }
   /**
+   * Builds the status code error message from the response status, optional description, and request details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -121,17 +167,23 @@ export class StatusCodeError extends /*#__PURE__*/Data.TaggedError("StatusCodeEr
   }
 }
 /**
- * @since 4.0.0
+ * Response error for failures while decoding an HTTP response body.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class DecodeError extends /*#__PURE__*/Data.TaggedError("DecodeError") {
   /**
+   * Formats the request method and URL for response decoding error messages.
+   *
    * @since 4.0.0
    */
   get methodAndUrl() {
     return `${this.request.method} ${this.request.url}`;
   }
   /**
+   * Builds the response decoding error message from the response status, optional description, and request details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -140,17 +192,23 @@ export class DecodeError extends /*#__PURE__*/Data.TaggedError("DecodeError") {
   }
 }
 /**
- * @since 4.0.0
+ * Response error for operations that expected a response body but received an empty body.
+ *
  * @category error
+ * @since 4.0.0
  */
 export class EmptyBodyError extends /*#__PURE__*/Data.TaggedError("EmptyBodyError") {
   /**
+   * Formats the request method and URL for empty response body error messages.
+   *
    * @since 4.0.0
    */
   get methodAndUrl() {
     return `${this.request.method} ${this.request.url}`;
   }
   /**
+   * Builds the empty body error message from the response status, optional description, and request details.
+   *
    * @since 4.0.0
    */
   get message() {
@@ -159,8 +217,10 @@ export class EmptyBodyError extends /*#__PURE__*/Data.TaggedError("EmptyBodyErro
   }
 }
 /**
- * @since 4.0.0
+ * Serializable schema representation of an `HttpClientError`, preserving the specific error kind and cause.
+ *
  * @category Schema
+ * @since 4.0.0
  */
 export class HttpClientErrorSchema extends /*#__PURE__*/Schema.ErrorClass(TypeId)({
   _tag: /*#__PURE__*/Schema.tag("HttpError"),
@@ -168,6 +228,8 @@ export class HttpClientErrorSchema extends /*#__PURE__*/Schema.ErrorClass(TypeId
   cause: /*#__PURE__*/Schema.optional(Schema.Defect)
 }) {
   /**
+   * Builds the serializable schema representation for an HTTP client error.
+   *
    * @since 4.0.0
    */
   static fromHttpClientError(error) {

package/dist/unstable/http/HttpClientError.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpClientError.js","names":["Data","hasProperty","Schema","TypeId","isHttpClientError","u","HttpClientError","TaggedError","constructor","props","reason","cause","request","response","undefined","message","formatReason","tag","endsWith","slice","formatMessage","description","info","TransportError","methodAndUrl","method","url","_tag","EncodeError","InvalidUrlError","StatusCodeError","status","DecodeError","EmptyBodyError","HttpClientErrorSchema","ErrorClass","kind","Literals","optional","Defect","fromHttpClientError","error"],"sources":["../../../src/unstable/http/HttpClientError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,IAAI,MAAM,eAAe;AACrC,SAASC,WAAW,QAAQ,oBAAoB;AAChD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAIzC,MAAMC,MAAM,GAAG,8BAA8B;AAE7C;;;;AAIA,OAAO,MAAMC,iBAAiB,GAAIC,CAAU,IAA2BJ,WAAW,CAACI,CAAC,EAAEF,MAAM,CAAC;AAE7F;;;;AAIA,OAAM,MAAOG,eAAgB,sBAAQN,IAAI,CAACO,WAAW,CAAC,iBAAiB,CAErE;EACAC,YAAYC,KAEX;IACC,IAAI,OAAO,IAAIA,KAAK,CAACC,MAAM,EAAE;MAC3B,KAAK,CAAC;QACJ,GAAGD,KAAK;QACRE,KAAK,EAAEF,KAAK,CAACC,MAAM,CAACC;OACd,CAAC;IACX,CAAC,MAAM;MACL,KAAK,CAACF,KAAK,CAAC;IACd;EACF;EAEA;;;EAGS,CAACN,MAAM,IAAIA,MAAM;EAE1B;;;EAGA,IAAIS,OAAOA,CAAA;IACT,OAAO,IAAI,CAACF,MAAM,CAACE,OAAO;EAC5B;EAEA;;;EAGA,IAAIC,QAAQA,CAAA;IACV,OAAO,UAAU,IAAI,IAAI,CAACH,MAAM,GAAG,IAAI,CAACA,MAAM,CAACG,QAAQ,GAAGC,SAAS;EACrE;EAEA,IAAaC,OAAOA,CAAA;IAClB,OAAO,IAAI,CAACL,MAAM,CAACK,OAAO;EAC5B;;AAGF,MAAMC,YAAY,GAAIC,GAAW,IAAKA,GAAG,CAACC,QAAQ,CAAC,OAAO,CAAC,GAAGD,GAAG,CAACE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAGF,GAAG;AAEpF,MAAMG,aAAa,GAAGA,CAACV,MAAc,EAAEW,WAA+B,EAAEC,IAAY,KAClFD,WAAW,GAAG,GAAGX,MAAM,KAAKW,WAAW,KAAKC,IAAI,GAAG,GAAG,GAAGZ,MAAM,WAAWY,IAAI,GAAG;AAEnF;;;;AAIA,OAAM,MAAOC,cAAe,sBAAQvB,IAAI,CAACO,WAAW,CAAC,gBAAgB,CAInE;EACA;;;EAGA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;EAGA,IAAaX,OAAOA,CAAA;IAClB,OAAOK,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAE,IAAI,CAACG,YAAY,CAAC;EACpF;;AAGF;;;;AAIA,OAAM,MAAOI,WAAY,sBAAQ5B,IAAI,CAACO,WAAW,CAAC,aAAa,CAI7D;EACA;;;EAGA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;EAGA,IAAaX,OAAOA,CAAA;IAClB,OAAOK,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAE,IAAI,CAACG,YAAY,CAAC;EACpF;;AAGF;;;;AAIA,OAAM,MAAOK,eAAgB,sBAAQ7B,IAAI,CAACO,WAAW,CAAC,iBAAiB,CAIrE;EACA;;;EAGA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;EAGA,IAAaX,OAAOA,CAAA;IAClB,OAAOK,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAE,IAAI,CAACG,YAAY,CAAC;EACpF;;AAGF;;;;AAIA,OAAM,MAAOM,eAAgB,sBAAQ9B,IAAI,CAACO,WAAW,CAAC,iBAAiB,CAKrE;EACA;;;EAGA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;EAGA,IAAaX,OAAOA,CAAA;IAClB,MAAMO,IAAI,GAAG,GAAG,IAAI,CAACT,QAAQ,CAACkB,MAAM,IAAI,IAAI,CAACP,YAAY,EAAE;IAC3D,OAAOJ,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAEC,IAAI,CAAC;EACvE;;AAGF;;;;AAIA,OAAM,MAAOU,WAAY,sBAAQhC,IAAI,CAACO,WAAW,CAAC,aAAa,CAK7D;EACA;;;EAGA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;EAGA,IAAaX,OAAOA,CAAA;IAClB,MAAMO,IAAI,GAAG,GAAG,IAAI,CAACT,QAAQ,CAACkB,MAAM,IAAI,IAAI,CAACP,YAAY,EAAE;IAC3D,OAAOJ,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAEC,IAAI,CAAC;EACvE;;AAGF;;;;AAIA,OAAM,MAAOW,cAAe,sBAAQjC,IAAI,CAACO,WAAW,CAAC,gBAAgB,CAKnE;EACA;;;EAGA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;EAGA,IAAaX,OAAOA,CAAA;IAClB,MAAMO,IAAI,GAAG,GAAG,IAAI,CAACT,QAAQ,CAACkB,MAAM,IAAI,IAAI,CAACP,YAAY,EAAE;IAC3D,OAAOJ,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAEC,IAAI,CAAC;EACvE;;AAqBF;;;;AAIA,OAAM,MAAOY,qBAAsB,sBAAQhC,MAAM,CAACiC,UAAU,CAAwBhC,MAAM,CAAC,CAAC;EAC1FwB,IAAI,eAAEzB,MAAM,CAACe,GAAG,CAAC,WAAW,CAAC;EAC7BmB,IAAI,eAAElC,MAAM,CAACmC,QAAQ,CACnB,CACE,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,CACsC,CACzD;EACD1B,KAAK,eAAET,MAAM,CAACoC,QAAQ,CAACpC,MAAM,CAACqC,MAAM;CACrC,CAAC;EACA;;;EAGA,OAAOC,mBAAmBA,CAACC,KAAsB;IAC/C,OAAO,IAAIP,qBAAqB,CAAC;MAC/BP,IAAI,EAAE,WAAW;MACjBS,IAAI,EAAEK,KAAK,CAAC/B,MAAM,CAACiB,IAAI;MACvBhB,KAAK,EAAE8B,KAAK,CAAC/B;KACd,CAAC;EACJ","ignoreList":[]}
+{"version":3,"file":"HttpClientError.js","names":["Data","hasProperty","Schema","TypeId","isHttpClientError","u","HttpClientError","TaggedError","constructor","props","reason","cause","request","response","undefined","message","formatReason","tag","endsWith","slice","formatMessage","description","info","TransportError","methodAndUrl","method","url","_tag","EncodeError","InvalidUrlError","StatusCodeError","status","DecodeError","EmptyBodyError","HttpClientErrorSchema","ErrorClass","kind","Literals","optional","Defect","fromHttpClientError","error"],"sources":["../../../src/unstable/http/HttpClientError.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;AAeA,OAAO,KAAKA,IAAI,MAAM,eAAe;AACrC,SAASC,WAAW,QAAQ,oBAAoB;AAChD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAIzC,MAAMC,MAAM,GAAG,8BAA8B;AAE7C;;;;;;AAMA,OAAO,MAAMC,iBAAiB,GAAIC,CAAU,IAA2BJ,WAAW,CAACI,CAAC,EAAEF,MAAM,CAAC;AAE7F;;;;;;AAMA,OAAM,MAAOG,eAAgB,sBAAQN,IAAI,CAACO,WAAW,CAAC,iBAAiB,CAErE;EACAC,YAAYC,KAEX;IACC,IAAI,OAAO,IAAIA,KAAK,CAACC,MAAM,EAAE;MAC3B,KAAK,CAAC;QACJ,GAAGD,KAAK;QACRE,KAAK,EAAEF,KAAK,CAACC,MAAM,CAACC;OACd,CAAC;IACX,CAAC,MAAM;MACL,KAAK,CAACF,KAAK,CAAC;IACd;EACF;EAEA;;;;;EAKS,CAACN,MAAM,IAAIA,MAAM;EAE1B;;;;;EAKA,IAAIS,OAAOA,CAAA;IACT,OAAO,IAAI,CAACF,MAAM,CAACE,OAAO;EAC5B;EAEA;;;;;EAKA,IAAIC,QAAQA,CAAA;IACV,OAAO,UAAU,IAAI,IAAI,CAACH,MAAM,GAAG,IAAI,CAACA,MAAM,CAACG,QAAQ,GAAGC,SAAS;EACrE;EAEA,IAAaC,OAAOA,CAAA;IAClB,OAAO,IAAI,CAACL,MAAM,CAACK,OAAO;EAC5B;;AAGF,MAAMC,YAAY,GAAIC,GAAW,IAAKA,GAAG,CAACC,QAAQ,CAAC,OAAO,CAAC,GAAGD,GAAG,CAACE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAGF,GAAG;AAEpF,MAAMG,aAAa,GAAGA,CAACV,MAAc,EAAEW,WAA+B,EAAEC,IAAY,KAClFD,WAAW,GAAG,GAAGX,MAAM,KAAKW,WAAW,KAAKC,IAAI,GAAG,GAAG,GAAGZ,MAAM,WAAWY,IAAI,GAAG;AAEnF;;;;;;AAMA,OAAM,MAAOC,cAAe,sBAAQvB,IAAI,CAACO,WAAW,CAAC,gBAAgB,CAInE;EACA;;;;;EAKA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;;;EAKA,IAAaX,OAAOA,CAAA;IAClB,OAAOK,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAE,IAAI,CAACG,YAAY,CAAC;EACpF;;AAGF;;;;;;AAMA,OAAM,MAAOI,WAAY,sBAAQ5B,IAAI,CAACO,WAAW,CAAC,aAAa,CAI7D;EACA;;;;;EAKA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;;;EAKA,IAAaX,OAAOA,CAAA;IAClB,OAAOK,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAE,IAAI,CAACG,YAAY,CAAC;EACpF;;AAGF;;;;;;AAMA,OAAM,MAAOK,eAAgB,sBAAQ7B,IAAI,CAACO,WAAW,CAAC,iBAAiB,CAIrE;EACA;;;;;EAKA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;;;EAKA,IAAaX,OAAOA,CAAA;IAClB,OAAOK,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAE,IAAI,CAACG,YAAY,CAAC;EACpF;;AAGF;;;;;;AAMA,OAAM,MAAOM,eAAgB,sBAAQ9B,IAAI,CAACO,WAAW,CAAC,iBAAiB,CAKrE;EACA;;;;;EAKA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;;;EAKA,IAAaX,OAAOA,CAAA;IAClB,MAAMO,IAAI,GAAG,GAAG,IAAI,CAACT,QAAQ,CAACkB,MAAM,IAAI,IAAI,CAACP,YAAY,EAAE;IAC3D,OAAOJ,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAEC,IAAI,CAAC;EACvE;;AAGF;;;;;;AAMA,OAAM,MAAOU,WAAY,sBAAQhC,IAAI,CAACO,WAAW,CAAC,aAAa,CAK7D;EACA;;;;;EAKA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;;;EAKA,IAAaX,OAAOA,CAAA;IAClB,MAAMO,IAAI,GAAG,GAAG,IAAI,CAACT,QAAQ,CAACkB,MAAM,IAAI,IAAI,CAACP,YAAY,EAAE;IAC3D,OAAOJ,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAEC,IAAI,CAAC;EACvE;;AAGF;;;;;;AAMA,OAAM,MAAOW,cAAe,sBAAQjC,IAAI,CAACO,WAAW,CAAC,gBAAgB,CAKnE;EACA;;;;;EAKA,IAAIiB,YAAYA,CAAA;IACd,OAAO,GAAG,IAAI,CAACZ,OAAO,CAACa,MAAM,IAAI,IAAI,CAACb,OAAO,CAACc,GAAG,EAAE;EACrD;EAEA;;;;;EAKA,IAAaX,OAAOA,CAAA;IAClB,MAAMO,IAAI,GAAG,GAAG,IAAI,CAACT,QAAQ,CAACkB,MAAM,IAAI,IAAI,CAACP,YAAY,EAAE;IAC3D,OAAOJ,aAAa,CAACJ,YAAY,CAAC,IAAI,CAACW,IAAI,CAAC,EAAE,IAAI,CAACN,WAAW,EAAEC,IAAI,CAAC;EACvE;;AA2BF;;;;;;AAMA,OAAM,MAAOY,qBAAsB,sBAAQhC,MAAM,CAACiC,UAAU,CAAwBhC,MAAM,CAAC,CAAC;EAC1FwB,IAAI,eAAEzB,MAAM,CAACe,GAAG,CAAC,WAAW,CAAC;EAC7BmB,IAAI,eAAElC,MAAM,CAACmC,QAAQ,CACnB,CACE,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,CACsC,CACzD;EACD1B,KAAK,eAAET,MAAM,CAACoC,QAAQ,CAACpC,MAAM,CAACqC,MAAM;CACrC,CAAC;EACA;;;;;EAKA,OAAOC,mBAAmBA,CAACC,KAAsB;IAC/C,OAAO,IAAIP,qBAAqB,CAAC;MAC/BP,IAAI,EAAE,WAAW;MACjBS,IAAI,EAAEK,KAAK,CAAC/B,MAAM,CAACiB,IAAI;MACvBhB,KAAK,EAAE8B,KAAK,CAAC/B;KACd,CAAC;EACJ","ignoreList":[]}