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

package/dist/unstable/http/Headers.js

@@ -1,19 +1,56 @@
 /**
- * Utilities for representing and transforming HTTP headers.
- *
- * This module provides an immutable `Headers` collection for request and
- * response metadata, along with constructors and combinators for common header
- * workflows such as reading values, checking for presence, setting or merging
- * header sets, removing names, and redacting sensitive headers before
- * inspection.
- *
- * Header names are normalized to lowercase by the safe constructors and
- * lookups, matching HTTP's case-insensitive header-name semantics. Each stored
- * header name maps to a single string value: array values in record input are
- * joined with `", "`, iterable input keeps the last value for duplicate names,
- * and later values override earlier ones when setting or merging. Be careful
- * with headers that require distinct field lines, such as `set-cookie`, because
- * this representation does not preserve multiple values separately.
+ * Immutable HTTP header collections for the unstable HTTP modules.
+ *
+ * This module defines the `Headers` data type used by HTTP client and server
+ * request / response models. It converts records or iterables into a
+ * predictable lowercase map, provides pipeable operations for reading and
+ * updating header values, and integrates with inspection redaction so sensitive
+ * header names can be masked before logging or serialization.
+ *
+ * ## Mental model
+ *
+ * A `Headers` value is a plain immutable record whose keys are normalized
+ * header names and whose values are strings. Safe constructors and lookups
+ * lowercase names because HTTP header names are case-insensitive, and
+ * combinators return new `Headers` values instead of mutating the original
+ * collection.
+ *
+ * ## Common tasks
+ *
+ * - Build headers from records or entry iterables with {@link fromInput}.
+ * - Read values with {@link get} or check presence with {@link has}.
+ * - Add, replace, merge, or remove headers with {@link set}, {@link setAll},
+ *   {@link merge}, {@link remove}, and {@link removeMany}.
+ * - Mask sensitive names before inspection with {@link redact} and
+ *   {@link CurrentRedactedNames}.
+ *
+ * ## Gotchas
+ *
+ * Each lowercase header name stores one string. Record array values are joined
+ * with `", "`, iterable input keeps the last value for duplicate names, and
+ * later set / merge operations replace earlier values. This is convenient for
+ * most headers but does not preserve repeated field lines such as `Set-Cookie`;
+ * use cookie-specific HTTP modules when cookie multiplicity matters.
+ *
+ * **Example** (Normalize and update headers)
+ *
+ * ```ts
+ * import { Option } from "effect"
+ * import { Headers } from "effect/unstable/http"
+ *
+ * const headers = Headers.fromInput({
+ *   "Content-Type": "application/json",
+ *   accept: ["application/json", "text/plain"]
+ * })
+ *
+ * const contentType = Headers.get(headers, "content-type")
+ * if (Option.isSome(contentType)) {
+ *   console.log(contentType.value)
+ * }
+ *
+ * const next = Headers.set(headers, "authorization", "Bearer token")
+ * console.log(Headers.has(next, "Authorization")) // true
+ * ```
  *
  * @since 4.0.0
  */
@@ -31,7 +68,7 @@ import * as Redacted from "../../Redacted.js";
 import * as Schema from "../../Schema.js";
 import * as Transformation from "../../SchemaTransformation.js";
 /**
- * This is a symbol to allow direct access of keys without conflicts.
+ * Runtime type identifier for `Headers` values.
  *
  * @category type IDs
  * @since 4.0.0
@@ -78,9 +115,10 @@ Object.defineProperties(Proto, {
 });
 const make = input => Object.assign(Object.create(Proto), input);
 /**
- * Equivalence instance that compares `Headers` by their header names and string values.
+ * Provides an `Equivalence` instance that compares `Headers` by header names
+ * and string values.
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const Equivalence = /*#__PURE__*/Record.makeEquivalence(/*#__PURE__*/Equ.strictEqual());
@@ -151,7 +189,7 @@ export const fromInput = input => {
   return out;
 };
 /**
- * Unsafely treats an existing record as `Headers`.
+ * Treats an existing record as `Headers` unsafely.
  *
  * **Gotchas**
  *
@@ -173,7 +211,7 @@ export const fromRecordUnsafe = input => Object.setPrototypeOf(input, Proto);
  */
 export const has = /*#__PURE__*/dual(2, (self, key) => key.toLowerCase() in self);
 /**
- * Gets a header value by name.
+ * Gets a header value by name safely.
  *
  * **Details**
  *

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

@@ -1 +1 @@
-{"version":3,"file":"Headers.js","names":["Context","Equal","Equ","dual","Hash","Inspectable","Option","Predicate","Record","Redactable","Redacted","Schema","Transformation","TypeId","Symbol","for","isHeaders","u","hasProperty","Proto","Object","create","defineProperties","value","symbolRedactable","context","redact","get","CurrentRedactedNames","toJSON","symbol","that","Equivalence","structure","toString","BaseProto","NodeInspectSymbol","make","input","assign","makeEquivalence","strictEqual","HeadersSchema","declare","typeConstructor","_tag","generation","runtime","Type","Encoded","importDeclaration","expected","toEquivalence","toCodec","link","String","transform","decode","fromInput","encode","headers","empty","undefined","iterator","out","k","v","toLowerCase","entries","Array","isArray","join","fromRecordUnsafe","setPrototypeOf","has","self","key","fromUndefinedOr","set","setAll","merge","remove","removeMany","keys","modify","name","test","i","length","Reference","defaultValue"],"sources":["../../../src/unstable/http/Headers.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,GAAG,MAAM,sBAAsB;AAC3C,SAASC,IAAI,QAAQ,mBAAmB;AACxC,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,WAAW,MAAM,sBAAsB;AACnD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,UAAU,MAAM,qBAAqB;AACjD,OAAO,KAAKC,QAAQ,MAAM,mBAAmB;AAC7C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAG/D;;;;;;AAMA,OAAO,MAAMC,MAAM,gBAAkBC,MAAM,CAACC,GAAG,CAAC,sBAAsB,CAAC;AAUvE;;;;;;AAMA,OAAO,MAAMC,SAAS,GAAIC,CAAU,IAAmBV,SAAS,CAACW,WAAW,CAACD,CAAC,EAAEJ,MAAM,CAAC;AAiBvF,MAAMM,KAAK,gBAAGC,MAAM,CAACC,MAAM,CAAC,IAAI,CAAC;AAEjCD,MAAM,CAACE,gBAAgB,CAACH,KAAK,EAAE;EAC7B,CAACN,MAAM,GAAG;IACRU,KAAK,EAAEV;GACR;EACD,CAACJ,UAAU,CAACe,gBAAgB,GAAG;IAC7BD,KAAKA,CAAgBE,OAA+B;MAClD,OAAOC,MAAM,CAAC,IAAI,EAAE1B,OAAO,CAAC2B,GAAG,CAACF,OAAO,EAAEG,oBAAoB,CAAC,CAAC;IACjE;GACD;EACDC,MAAM,EAAE;IACNN,KAAKA,CAAA;MACH,OAAOd,UAAU,CAACiB,MAAM,CAAC,IAAI,CAAC;IAChC;GACD;EACD,CAACzB,KAAK,CAAC6B,MAAM,GAAG;IACdP,KAAKA,CAAgBQ,IAAa;MAChC,OAAOC,WAAW,CAAC,IAAI,EAAED,IAAI,CAAC;IAChC;GACD;EACD,CAAC3B,IAAI,CAAC0B,MAAM,GAAG;IACbP,KAAKA,CAAA;MACH,OAAOnB,IAAI,CAAC6B,SAAS,CAAC,IAAI,CAAC;IAC7B;GACD;EACDC,QAAQ,EAAE;IACRX,KAAK,EAAElB,WAAW,CAAC8B,SAAS,CAACD;GAC9B;EACD,CAAC7B,WAAW,CAAC+B,iBAAiB,GAAG;IAC/Bb,KAAK,EAAElB,WAAW,CAAC8B,SAAS,CAAC9B,WAAW,CAAC+B,iBAAiB;;CAE7D,CAAC;AAEF,MAAMC,IAAI,GAAIC,KAA4C,IACxDlB,MAAM,CAACmB,MAAM,CAACnB,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC,EAAEmB,KAAK,CAAY;AAEvD;;;;;;AAMA,OAAO,MAAMN,WAAW,gBAA6BxB,MAAM,CAACgC,eAAe,cAACtC,GAAG,CAACuC,WAAW,EAAU,CAAC;AAUtG;;;;;;;;;;AAUA,OAAO,MAAMC,aAAa,gBAAkB/B,MAAM,CAACgC,OAAO,CACxD3B,SAAS,EACT;EACE4B,eAAe,EAAE;IACfC,IAAI,EAAE;GACP;EACDC,UAAU,EAAE;IACVC,OAAO,EAAE,uBAAuB;IAChCC,IAAI,EAAE,iBAAiB;IACvBC,OAAO,EAAE,yCAAyC;IAClDC,iBAAiB,EAAE;GACpB;EACDC,QAAQ,EAAE,SAAS;EACnBC,aAAa,EAAEA,CAAA,KAAMpB,WAAW;EAChCqB,OAAO,EAAEA,CAAA,KACP1C,MAAM,CAAC2C,IAAI,EAAW,CACpB3C,MAAM,CAACH,MAAM,CAACG,MAAM,CAAC4C,MAAM,EAAE5C,MAAM,CAAC4C,MAAM,CAAC,EAC3C3C,cAAc,CAAC4C,SAAS,CAAC;IACvBC,MAAM,EAAGnB,KAAK,IAAKoB,SAAS,CAACpB,KAAK,CAAC;IACnCqB,MAAM,EAAGC,OAAO,KAAM;MAAE,GAAGA;IAAO,CAAE;GACrC,CAAC;CAEP,CACF;AAgBD;;;;;;AAMA,OAAO,MAAMC,KAAK,gBAAYzC,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC;AAElD;;;;;;;;;;AAUA,OAAO,MAAMuC,SAAS,GAAgCpB,KAAK,IAAI;EAC7D,IAAIA,KAAK,KAAKwB,SAAS,EAAE;IACvB,OAAOD,KAAK;EACd,CAAC,MAAM,IAAI/C,MAAM,CAACiD,QAAQ,IAAIzB,KAAK,EAAE;IACnC,MAAM0B,GAAG,GAA2B5C,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC;IACxD,KAAK,MAAM,CAAC8C,CAAC,EAAEC,CAAC,CAAC,IAAI5B,KAAK,EAAE;MAC1B0B,GAAG,CAACC,CAAC,CAACE,WAAW,EAAE,CAAC,GAAGD,CAAC;IAC1B;IACA,OAAOF,GAAc;EACvB;EACA,MAAMA,GAAG,GAA2B5C,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC;EACxD,KAAK,MAAM,CAAC8C,CAAC,EAAEC,CAAC,CAAC,IAAI9C,MAAM,CAACgD,OAAO,CAAC9B,KAAK,CAAC,EAAE;IAC1C,IAAI+B,KAAK,CAACC,OAAO,CAACJ,CAAC,CAAC,EAAE;MACpBF,GAAG,CAACC,CAAC,CAACE,WAAW,EAAE,CAAC,GAAGD,CAAC,CAACK,IAAI,CAAC,IAAI,CAAC;IACrC,CAAC,MAAM,IAAIL,CAAC,KAAKJ,SAAS,EAAE;MAC1BE,GAAG,CAACC,CAAC,CAACE,WAAW,EAAE,CAAC,GAAGD,CAAW;IACpC;EACF;EACA,OAAOF,GAAc;AACvB,CAAC;AAED;;;;;;;;;;AAUA,OAAO,MAAMQ,gBAAgB,GAAIlC,KAA4C,IAC3ElB,MAAM,CAACqD,cAAc,CAACnC,KAAK,EAAEnB,KAAK,CAAY;AAEhD;;;;;;;;;;AAUA,OAAO,MAAMuD,GAAG,gBAuBZvE,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,KAAKA,GAAG,CAACT,WAAW,EAAE,IAAIQ,IAAI,CAAC;AAE9C;;;;;;;;;;AAUA,OAAO,MAAMhD,GAAG,gBAuBZxB,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,KAAKtE,MAAM,CAACuE,eAAe,CAACF,IAAI,CAACC,GAAG,CAACT,WAAW,EAAE,CAAC,CAAC,CAAC;AAEpE;;;;;;;;;;AAUA,OAAO,MAAMW,GAAG,gBAuBZ3E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,EAAErD,KAAK,KAAI;EACxB,MAAMyC,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtBX,GAAG,CAACY,GAAG,CAACT,WAAW,EAAE,CAAC,GAAG5C,KAAK;EAC9B,OAAOyC,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMe,MAAM,gBAuBf5E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEf,OAAO,KACjBvB,IAAI,CAAC;EACH,GAAGsC,IAAI;EACP,GAAGjB,SAAS,CAACE,OAAO;CACrB,CAAC,CAAC;AAEL;;;;;;;;;;AAUA,OAAO,MAAMoB,KAAK,gBAuBd7E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEf,OAAO,KAAI;EACrB,MAAMI,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtBvD,MAAM,CAACmB,MAAM,CAACyB,GAAG,EAAEJ,OAAO,CAAC;EAC3B,OAAOI,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMiB,MAAM,gBAuBf9E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,KAAI;EACjB,MAAMZ,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtB,OAAOX,GAAG,CAACY,GAAG,CAACT,WAAW,EAAE,CAAC;EAC7B,OAAOH,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMkB,UAAU,gBAuBnB/E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEQ,IAAI,KAAI;EAClB,MAAMnB,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtB,KAAK,MAAMC,GAAG,IAAIO,IAAI,EAAE;IACtB,OAAOnB,GAAG,CAACY,GAAG,CAACT,WAAW,EAAE,CAAC;EAC/B;EACA,OAAOH,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMtC,MAAM,gBAuBfvB,IAAI,CACN,CAAC,EACD,CACEwE,IAAa,EACbC,GAAqD,KACP;EAC9C,MAAMZ,GAAG,GAA+C;IAAE,GAAGW;EAAI,CAAE;EACnE,MAAMS,MAAM,GAAIR,GAAoB,IAAI;IACtC,IAAI,OAAOA,GAAG,KAAK,QAAQ,EAAE;MAC3B,MAAMX,CAAC,GAAGW,GAAG,CAACT,WAAW,EAAE;MAC3B,IAAIF,CAAC,IAAIU,IAAI,EAAE;QACbX,GAAG,CAACC,CAAC,CAAC,GAAGvD,QAAQ,CAAC2B,IAAI,CAACsC,IAAI,CAACV,CAAC,CAAC,CAAC;MACjC;IACF,CAAC,MAAM;MACL,KAAK,MAAMoB,IAAI,IAAIV,IAAI,EAAE;QACvB,IAAIC,GAAG,CAACU,IAAI,CAACD,IAAI,CAAC,EAAE;UAClBrB,GAAG,CAACqB,IAAI,CAAC,GAAG3E,QAAQ,CAAC2B,IAAI,CAACsC,IAAI,CAACU,IAAI,CAAC,CAAC;QACvC;MACF;IACF;EACF,CAAC;EACD,IAAIhB,KAAK,CAACC,OAAO,CAACM,GAAG,CAAC,EAAE;IACtB,KAAK,IAAIW,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGX,GAAG,CAACY,MAAM,EAAED,CAAC,EAAE,EAAE;MACnCH,MAAM,CAACR,GAAG,CAACW,CAAC,CAAC,CAAC;IAChB;EACF,CAAC,MAAM;IACLH,MAAM,CAACR,GAAsB,CAAC;EAChC;EACA,OAAOZ,GAAG;AACZ,CAAC,CACF;AAED;;;;;;;;;;AAUA,OAAO,MAAMpC,oBAAoB,gBAAG5B,OAAO,CAACyF,SAAS,CAEnD,qCAAqC,EAAE;EACvCC,YAAY,EAAEA,CAAA,KAAM,CAClB,eAAe,EACf,QAAQ,EACR,YAAY,EACZ,WAAW;CAEd,CAAC","ignoreList":[]}
+{"version":3,"file":"Headers.js","names":["Context","Equal","Equ","dual","Hash","Inspectable","Option","Predicate","Record","Redactable","Redacted","Schema","Transformation","TypeId","Symbol","for","isHeaders","u","hasProperty","Proto","Object","create","defineProperties","value","symbolRedactable","context","redact","get","CurrentRedactedNames","toJSON","symbol","that","Equivalence","structure","toString","BaseProto","NodeInspectSymbol","make","input","assign","makeEquivalence","strictEqual","HeadersSchema","declare","typeConstructor","_tag","generation","runtime","Type","Encoded","importDeclaration","expected","toEquivalence","toCodec","link","String","transform","decode","fromInput","encode","headers","empty","undefined","iterator","out","k","v","toLowerCase","entries","Array","isArray","join","fromRecordUnsafe","setPrototypeOf","has","self","key","fromUndefinedOr","set","setAll","merge","remove","removeMany","keys","modify","name","test","i","length","Reference","defaultValue"],"sources":["../../../src/unstable/http/Headers.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,OAAO,KAAKC,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAKC,GAAG,MAAM,sBAAsB;AAC3C,SAASC,IAAI,QAAQ,mBAAmB;AACxC,OAAO,KAAKC,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,WAAW,MAAM,sBAAsB;AACnD,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,UAAU,MAAM,qBAAqB;AACjD,OAAO,KAAKC,QAAQ,MAAM,mBAAmB;AAC7C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAG/D;;;;;;AAMA,OAAO,MAAMC,MAAM,gBAAkBC,MAAM,CAACC,GAAG,CAAC,sBAAsB,CAAC;AAUvE;;;;;;AAMA,OAAO,MAAMC,SAAS,GAAIC,CAAU,IAAmBV,SAAS,CAACW,WAAW,CAACD,CAAC,EAAEJ,MAAM,CAAC;AAiBvF,MAAMM,KAAK,gBAAGC,MAAM,CAACC,MAAM,CAAC,IAAI,CAAC;AAEjCD,MAAM,CAACE,gBAAgB,CAACH,KAAK,EAAE;EAC7B,CAACN,MAAM,GAAG;IACRU,KAAK,EAAEV;GACR;EACD,CAACJ,UAAU,CAACe,gBAAgB,GAAG;IAC7BD,KAAKA,CAAgBE,OAA+B;MAClD,OAAOC,MAAM,CAAC,IAAI,EAAE1B,OAAO,CAAC2B,GAAG,CAACF,OAAO,EAAEG,oBAAoB,CAAC,CAAC;IACjE;GACD;EACDC,MAAM,EAAE;IACNN,KAAKA,CAAA;MACH,OAAOd,UAAU,CAACiB,MAAM,CAAC,IAAI,CAAC;IAChC;GACD;EACD,CAACzB,KAAK,CAAC6B,MAAM,GAAG;IACdP,KAAKA,CAAgBQ,IAAa;MAChC,OAAOC,WAAW,CAAC,IAAI,EAAED,IAAI,CAAC;IAChC;GACD;EACD,CAAC3B,IAAI,CAAC0B,MAAM,GAAG;IACbP,KAAKA,CAAA;MACH,OAAOnB,IAAI,CAAC6B,SAAS,CAAC,IAAI,CAAC;IAC7B;GACD;EACDC,QAAQ,EAAE;IACRX,KAAK,EAAElB,WAAW,CAAC8B,SAAS,CAACD;GAC9B;EACD,CAAC7B,WAAW,CAAC+B,iBAAiB,GAAG;IAC/Bb,KAAK,EAAElB,WAAW,CAAC8B,SAAS,CAAC9B,WAAW,CAAC+B,iBAAiB;;CAE7D,CAAC;AAEF,MAAMC,IAAI,GAAIC,KAA4C,IACxDlB,MAAM,CAACmB,MAAM,CAACnB,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC,EAAEmB,KAAK,CAAY;AAEvD;;;;;;;AAOA,OAAO,MAAMN,WAAW,gBAA6BxB,MAAM,CAACgC,eAAe,cAACtC,GAAG,CAACuC,WAAW,EAAU,CAAC;AAUtG;;;;;;;;;;AAUA,OAAO,MAAMC,aAAa,gBAAkB/B,MAAM,CAACgC,OAAO,CACxD3B,SAAS,EACT;EACE4B,eAAe,EAAE;IACfC,IAAI,EAAE;GACP;EACDC,UAAU,EAAE;IACVC,OAAO,EAAE,uBAAuB;IAChCC,IAAI,EAAE,iBAAiB;IACvBC,OAAO,EAAE,yCAAyC;IAClDC,iBAAiB,EAAE;GACpB;EACDC,QAAQ,EAAE,SAAS;EACnBC,aAAa,EAAEA,CAAA,KAAMpB,WAAW;EAChCqB,OAAO,EAAEA,CAAA,KACP1C,MAAM,CAAC2C,IAAI,EAAW,CACpB3C,MAAM,CAACH,MAAM,CAACG,MAAM,CAAC4C,MAAM,EAAE5C,MAAM,CAAC4C,MAAM,CAAC,EAC3C3C,cAAc,CAAC4C,SAAS,CAAC;IACvBC,MAAM,EAAGnB,KAAK,IAAKoB,SAAS,CAACpB,KAAK,CAAC;IACnCqB,MAAM,EAAGC,OAAO,KAAM;MAAE,GAAGA;IAAO,CAAE;GACrC,CAAC;CAEP,CACF;AAgBD;;;;;;AAMA,OAAO,MAAMC,KAAK,gBAAYzC,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC;AAElD;;;;;;;;;;AAUA,OAAO,MAAMuC,SAAS,GAAgCpB,KAAK,IAAI;EAC7D,IAAIA,KAAK,KAAKwB,SAAS,EAAE;IACvB,OAAOD,KAAK;EACd,CAAC,MAAM,IAAI/C,MAAM,CAACiD,QAAQ,IAAIzB,KAAK,EAAE;IACnC,MAAM0B,GAAG,GAA2B5C,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC;IACxD,KAAK,MAAM,CAAC8C,CAAC,EAAEC,CAAC,CAAC,IAAI5B,KAAK,EAAE;MAC1B0B,GAAG,CAACC,CAAC,CAACE,WAAW,EAAE,CAAC,GAAGD,CAAC;IAC1B;IACA,OAAOF,GAAc;EACvB;EACA,MAAMA,GAAG,GAA2B5C,MAAM,CAACC,MAAM,CAACF,KAAK,CAAC;EACxD,KAAK,MAAM,CAAC8C,CAAC,EAAEC,CAAC,CAAC,IAAI9C,MAAM,CAACgD,OAAO,CAAC9B,KAAK,CAAC,EAAE;IAC1C,IAAI+B,KAAK,CAACC,OAAO,CAACJ,CAAC,CAAC,EAAE;MACpBF,GAAG,CAACC,CAAC,CAACE,WAAW,EAAE,CAAC,GAAGD,CAAC,CAACK,IAAI,CAAC,IAAI,CAAC;IACrC,CAAC,MAAM,IAAIL,CAAC,KAAKJ,SAAS,EAAE;MAC1BE,GAAG,CAACC,CAAC,CAACE,WAAW,EAAE,CAAC,GAAGD,CAAW;IACpC;EACF;EACA,OAAOF,GAAc;AACvB,CAAC;AAED;;;;;;;;;;AAUA,OAAO,MAAMQ,gBAAgB,GAAIlC,KAA4C,IAC3ElB,MAAM,CAACqD,cAAc,CAACnC,KAAK,EAAEnB,KAAK,CAAY;AAEhD;;;;;;;;;;AAUA,OAAO,MAAMuD,GAAG,gBAuBZvE,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,KAAKA,GAAG,CAACT,WAAW,EAAE,IAAIQ,IAAI,CAAC;AAE9C;;;;;;;;;;AAUA,OAAO,MAAMhD,GAAG,gBAuBZxB,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,KAAKtE,MAAM,CAACuE,eAAe,CAACF,IAAI,CAACC,GAAG,CAACT,WAAW,EAAE,CAAC,CAAC,CAAC;AAEpE;;;;;;;;;;AAUA,OAAO,MAAMW,GAAG,gBAuBZ3E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,EAAErD,KAAK,KAAI;EACxB,MAAMyC,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtBX,GAAG,CAACY,GAAG,CAACT,WAAW,EAAE,CAAC,GAAG5C,KAAK;EAC9B,OAAOyC,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMe,MAAM,gBAuBf5E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEf,OAAO,KACjBvB,IAAI,CAAC;EACH,GAAGsC,IAAI;EACP,GAAGjB,SAAS,CAACE,OAAO;CACrB,CAAC,CAAC;AAEL;;;;;;;;;;AAUA,OAAO,MAAMoB,KAAK,gBAuBd7E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEf,OAAO,KAAI;EACrB,MAAMI,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtBvD,MAAM,CAACmB,MAAM,CAACyB,GAAG,EAAEJ,OAAO,CAAC;EAC3B,OAAOI,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMiB,MAAM,gBAuBf9E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEC,GAAG,KAAI;EACjB,MAAMZ,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtB,OAAOX,GAAG,CAACY,GAAG,CAACT,WAAW,EAAE,CAAC;EAC7B,OAAOH,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMkB,UAAU,gBAuBnB/E,IAAI,CAuBN,CAAC,EAAE,CAACwE,IAAI,EAAEQ,IAAI,KAAI;EAClB,MAAMnB,GAAG,GAAG3B,IAAI,CAACsC,IAAI,CAAC;EACtB,KAAK,MAAMC,GAAG,IAAIO,IAAI,EAAE;IACtB,OAAOnB,GAAG,CAACY,GAAG,CAACT,WAAW,EAAE,CAAC;EAC/B;EACA,OAAOH,GAAG;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAMtC,MAAM,gBAuBfvB,IAAI,CACN,CAAC,EACD,CACEwE,IAAa,EACbC,GAAqD,KACP;EAC9C,MAAMZ,GAAG,GAA+C;IAAE,GAAGW;EAAI,CAAE;EACnE,MAAMS,MAAM,GAAIR,GAAoB,IAAI;IACtC,IAAI,OAAOA,GAAG,KAAK,QAAQ,EAAE;MAC3B,MAAMX,CAAC,GAAGW,GAAG,CAACT,WAAW,EAAE;MAC3B,IAAIF,CAAC,IAAIU,IAAI,EAAE;QACbX,GAAG,CAACC,CAAC,CAAC,GAAGvD,QAAQ,CAAC2B,IAAI,CAACsC,IAAI,CAACV,CAAC,CAAC,CAAC;MACjC;IACF,CAAC,MAAM;MACL,KAAK,MAAMoB,IAAI,IAAIV,IAAI,EAAE;QACvB,IAAIC,GAAG,CAACU,IAAI,CAACD,IAAI,CAAC,EAAE;UAClBrB,GAAG,CAACqB,IAAI,CAAC,GAAG3E,QAAQ,CAAC2B,IAAI,CAACsC,IAAI,CAACU,IAAI,CAAC,CAAC;QACvC;MACF;IACF;EACF,CAAC;EACD,IAAIhB,KAAK,CAACC,OAAO,CAACM,GAAG,CAAC,EAAE;IACtB,KAAK,IAAIW,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGX,GAAG,CAACY,MAAM,EAAED,CAAC,EAAE,EAAE;MACnCH,MAAM,CAACR,GAAG,CAACW,CAAC,CAAC,CAAC;IAChB;EACF,CAAC,MAAM;IACLH,MAAM,CAACR,GAAsB,CAAC;EAChC;EACA,OAAOZ,GAAG;AACZ,CAAC,CACF;AAED;;;;;;;;;;AAUA,OAAO,MAAMpC,oBAAoB,gBAAG5B,OAAO,CAACyF,SAAS,CAEnD,qCAAqC,EAAE;EACvCC,YAAY,EAAEA,CAAA,KAAM,CAClB,eAAe,EACf,QAAQ,EACR,YAAY,EACZ,WAAW;CAEd,CAAC","ignoreList":[]}

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

@@ -118,9 +118,13 @@ export declare class Empty extends Proto {
     toJSON(): unknown;
 }
 /**
- * Singleton empty HTTP body.
+ * Provides the singleton empty HTTP body.
  *
- * @category constructors
+ * **When to use**
+ *
+ * Use when you need an HTTP body value that represents no body content.
+ *
+ * @category constants
  * @since 4.0.0
  */
 export declare const empty: Empty;

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

@@ -1 +1 @@
-{"version":3,"file":"HttpBody.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpBody.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAA;AAEjD,OAAO,KAAK,WAAW,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,KAAK,aAAa,MAAM,wBAAwB,CAAA;AAE5D,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,KAAK,KAAK,OAAO,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C,QAAA,MAAM,MAAM,0BAA0B,CAAA;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,QAA4C,CAAA;AAEzF;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,GAAG,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAA;AAEnE;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC;;;;;;;;;OASG;IACH,UAAiB,KAAM,SAAQ,WAAW,CAAC,WAAW;QACpD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;QAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC5C;IAED;;;;;OAKG;IACH,UAAiB,QAAQ;QACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;QAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,OAAO,CAAA;QAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KACtB;CACF;AAED,QAAA,MAAM,mBAAmB,wCAAwC,CAAA;;;;AAEjE;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,mBAAkC;IACnE,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB,CAAC;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,mBAAmB,CAAC,yCAAsB;CACrD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;CAC3B,GAAG;IACF,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CACtB,CAAA;AAED,uBAAe,KAAM,YAAW,QAAQ,CAAC,KAAK;IAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;;IAI9B,QAAQ,CAAC,MAAM,IAAI,OAAO;IAC1B,CAAC,WAAW,CAAC,iBAAiB,CAAC,IAAI,OAAO;IAG1C,QAAQ,IAAI,MAAM;CAGnB;AAED;;;;;GAKG;AACH,qBAAa,KAAM,SAAQ,KAAK;IAC9B,QAAQ,CAAC,IAAI,WAAU;IACvB,MAAM,IAAI,OAAO;CAMlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,KAAK,EAAE,KAAmB,CAAA;AAEvC;;;;;GAKG;AACH,qBAAa,GAAI,SAAQ,KAAK;IAC5B,QAAQ,CAAC,IAAI,SAAQ;IACrB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;gBAGxC,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,aAAa,EAAE,MAAM,GAAG,SAAS;IAOnC,MAAM,IAAI,OAAO;CASlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,GAAG,GACd,MAAM,OAAO,EACb,UAAU;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5C,GAAG,SAAS,KACZ,GAAkE,CAAA;AAErE;;;;;;;;;GASG;AACH,qBAAa,UAAW,SAAQ,KAAK;IACnC,QAAQ,CAAC,IAAI,gBAAe;IAC5B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;gBAG5B,IAAI,EAAE,UAAU,CAAC,UAAU,EAC3B,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM;IAOvB,MAAM,IAAI,OAAO;CAUlB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,UAAU,CAAC,UAAU,EAAE,cAAc,MAAM,KAAG,UACD,CAAA;AAI9E;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,MAAM,EAAE,cAAc,MAAM,KAAG,UACK,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,OAAO,EAAE,cAAc,MAAM,KAAG,UACF,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,OAAO,EAAE,cAAc,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAI9F,CAAA;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAC7C,QAAQ,CAAC,EACT,UAAU,YAAY,GAAG,SAAS,MAG1B,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,cAAc,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,CAAC,CAAC,kBAAkB,CAAC,CAK/G,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,CAAC,SAAS,EAAE,cAAc,MAAM,KAAG,UACQ,CAAA;AAEzF;;;;;;;;;GASG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,cAAa;IAC1B,QAAQ,CAAC,WAAW,YAAY;IAChC,QAAQ,CAAC,aAAa,YAAY;IAClC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAA;gBAGpC,QAAQ,EAAE,UAAU,CAAC,QAAQ;IAK/B,MAAM,IAAI,OAAO;CAOlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,UAAU,CAAC,QAAQ,KAAG,QAA8B,CAAA;AAEnF;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAA;AAEhG;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,GAAG,IAAI,GAAG,SAAS,CAAA;AAahH;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,aAAa,KAAG,QAYvD,CAAA;AAED;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAC/B,QAAQ,CAAC,IAAI,YAAW;IACxB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;gBAGxC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,EACtD,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,GAAG,SAAS;IAOnC,MAAM,IAAI,OAAO;CAQlB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,GACjB,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,EACpD,cAAc,MAAM,EACpB,gBAAgB,MAAM,KACrB,MAAoF,CAAA;AAEvF;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GACf,MAAM,MAAM,EACZ,UAAU;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,KACA,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,EAAE,UAAU,CAAC,UAAU,CAUxE,CAAA;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,GACvB,MAAM,MAAM,EACZ,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,EAC1B,UAAU;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,KACA,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,EAAE,UAAU,CAAC,UAAU,CASxE,CAAA"}
+{"version":3,"file":"HttpBody.d.ts","sourceRoot":"","sources":["../../../src/unstable/http/HttpBody.ts"],"names":[],"mappings":"AA0DA,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAA;AAEjD,OAAO,KAAK,WAAW,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,KAAK,aAAa,MAAM,wBAAwB,CAAA;AAE5D,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,KAAK,KAAK,OAAO,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C,QAAA,MAAM,MAAM,0BAA0B,CAAA;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,QAA4C,CAAA;AAEzF;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,GAAG,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAA;AAEnE;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC;;;;;;;;;OASG;IACH,UAAiB,KAAM,SAAQ,WAAW,CAAC,WAAW;QACpD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;QAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC5C;IAED;;;;;OAKG;IACH,UAAiB,QAAQ;QACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;QAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,OAAO,CAAA;QAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KACtB;CACF;AAED,QAAA,MAAM,mBAAmB,wCAAwC,CAAA;;;;AAEjE;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,mBAAkC;IACnE,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB,CAAC;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,mBAAmB,CAAC,yCAAsB;CACrD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;CAC3B,GAAG;IACF,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CACtB,CAAA;AAED,uBAAe,KAAM,YAAW,QAAQ,CAAC,KAAK;IAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;;IAI9B,QAAQ,CAAC,MAAM,IAAI,OAAO;IAC1B,CAAC,WAAW,CAAC,iBAAiB,CAAC,IAAI,OAAO;IAG1C,QAAQ,IAAI,MAAM;CAGnB;AAED;;;;;GAKG;AACH,qBAAa,KAAM,SAAQ,KAAK;IAC9B,QAAQ,CAAC,IAAI,WAAU;IACvB,MAAM,IAAI,OAAO;CAMlB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK,EAAE,KAAmB,CAAA;AAEvC;;;;;GAKG;AACH,qBAAa,GAAI,SAAQ,KAAK;IAC5B,QAAQ,CAAC,IAAI,SAAQ;IACrB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;gBAGxC,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,aAAa,EAAE,MAAM,GAAG,SAAS;IAOnC,MAAM,IAAI,OAAO;CASlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,GAAG,GACd,MAAM,OAAO,EACb,UAAU;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5C,GAAG,SAAS,KACZ,GAAkE,CAAA;AAErE;;;;;;;;;GASG;AACH,qBAAa,UAAW,SAAQ,KAAK;IACnC,QAAQ,CAAC,IAAI,gBAAe;IAC5B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;gBAG5B,IAAI,EAAE,UAAU,CAAC,UAAU,EAC3B,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM;IAOvB,MAAM,IAAI,OAAO;CAUlB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,UAAU,CAAC,UAAU,EAAE,cAAc,MAAM,KAAG,UACD,CAAA;AAI9E;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,MAAM,EAAE,cAAc,MAAM,KAAG,UACK,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,OAAO,EAAE,cAAc,MAAM,KAAG,UACF,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,OAAO,EAAE,cAAc,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAI9F,CAAA;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAC7C,QAAQ,CAAC,EACT,UAAU,YAAY,GAAG,SAAS,MAG1B,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,cAAc,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,EAAE,CAAC,CAAC,kBAAkB,CAAC,CAK/G,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,CAAC,SAAS,EAAE,cAAc,MAAM,KAAG,UACQ,CAAA;AAEzF;;;;;;;;;GASG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,cAAa;IAC1B,QAAQ,CAAC,WAAW,YAAY;IAChC,QAAQ,CAAC,aAAa,YAAY;IAClC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAA;gBAGpC,QAAQ,EAAE,UAAU,CAAC,QAAQ;IAK/B,MAAM,IAAI,OAAO;CAOlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,UAAU,CAAC,QAAQ,KAAG,QAA8B,CAAA;AAEnF;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAA;AAEhG;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,GAAG,IAAI,GAAG,SAAS,CAAA;AAahH;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,aAAa,KAAG,QAYvD,CAAA;AAED;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAC/B,QAAQ,CAAC,IAAI,YAAW;IACxB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;gBAGxC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,EACtD,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,GAAG,SAAS;IAOnC,MAAM,IAAI,OAAO;CAQlB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,GACjB,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,EACpD,cAAc,MAAM,EACpB,gBAAgB,MAAM,KACrB,MAAoF,CAAA;AAEvF;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GACf,MAAM,MAAM,EACZ,UAAU;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,KACA,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,EAAE,UAAU,CAAC,UAAU,CAUxE,CAAA;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,GACvB,MAAM,MAAM,EACZ,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,EAC1B,UAAU;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,KACA,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,EAAE,UAAU,CAAC,UAAU,CASxE,CAAA"}

package/dist/unstable/http/HttpBody.js

@@ -1,17 +1,57 @@
 /**
- * Utilities and data types for describing outgoing HTTP body content.
- *
- * This module provides a small set of `HttpBody` variants used by HTTP client
- * requests and server responses: empty bodies, raw runtime values, in-memory
- * bytes, `FormData`, and byte streams. Constructors cover the common cases of
- * text, JSON, URL-encoded forms, multipart forms, and files while carrying the
- * content type and, when known, the content length used by platform adapters.
- *
- * Streaming bodies are represented as streams of `Uint8Array` chunks and may
- * omit `contentLength` when the size is not known ahead of time. Multipart
- * `FormData` intentionally leaves `contentType` unset so the runtime can add
- * the required boundary; setting that header manually can produce invalid
- * requests.
+ * Describes the body attached to outgoing HTTP requests and server responses.
+ *
+ * `HttpBody` is the transport-facing representation used by the HTTP modules
+ * before a platform adapter turns a request or response into a concrete Web,
+ * Node, or other runtime value. Each body variant carries the payload plus the
+ * metadata an adapter can safely know ahead of time, such as `contentType` and
+ * `contentLength`.
+ *
+ * **Mental model**
+ *
+ * - {@link empty} represents an absent body.
+ * - {@link uint8Array}, {@link text}, {@link jsonUnsafe}, {@link json}, and
+ *   {@link urlParams} build in-memory byte bodies with content metadata.
+ * - {@link formData} and {@link formDataRecord} keep multipart data as
+ *   `FormData` so the runtime can generate the boundary.
+ * - {@link stream} represents a stream of `Uint8Array` chunks and may omit the
+ *   content length when the final size is not known.
+ * - {@link raw} is the escape hatch for platform-specific body values that an
+ *   adapter already knows how to send.
+ *
+ * **Common tasks**
+ *
+ * - Send text, bytes, JSON, URL-encoded data, multipart forms, or files.
+ * - Use {@link json} or {@link jsonSchema} when JSON encoding failures should
+ *   be represented as `HttpBodyError` values.
+ * - Use {@link file} or {@link fileFromInfo} when file metadata should become
+ *   `contentType` / `contentLength` metadata for the adapter.
+ * - Use {@link isHttpBody} when accepting unknown values at an integration
+ *   boundary.
+ *
+ * **Gotchas**
+ *
+ * - {@link jsonUnsafe} calls `JSON.stringify` directly and can throw; prefer
+ *   {@link json} in effectful code.
+ * - `FormData` bodies intentionally leave `contentType` unset because setting a
+ *   multipart header without the generated boundary produces invalid requests.
+ * - Stream bodies may not have a `contentLength`; code that requires one must
+ *   provide it explicitly when constructing the stream body.
+ *
+ * **Example** (Creating common body variants)
+ *
+ * ```ts
+ * import { HttpBody, UrlParams } from "effect/unstable/http"
+ * import * as assert from "node:assert"
+ *
+ * const textBody = HttpBody.text("hello")
+ * const jsonBody = HttpBody.jsonUnsafe({ name: "Ada" })
+ * const formBody = HttpBody.urlParams(UrlParams.fromInput({ q: "effect" }))
+ *
+ * assert.equal(textBody.contentType, "text/plain")
+ * assert.equal(jsonBody.contentType, "application/json")
+ * assert.equal(formBody.contentType, "application/x-www-form-urlencoded")
+ * ```
  *
  * @since 4.0.0
  */
@@ -77,9 +117,13 @@ export class Empty extends Proto {
   }
 }
 /**
- * Singleton empty HTTP body.
+ * Provides the singleton empty HTTP body.
  *
- * @category constructors
+ * **When to use**
+ *
+ * Use when you need an HTTP body value that represents no body content.
+ *
+ * @category constants
  * @since 4.0.0
  */
 export const empty = /*#__PURE__*/new Empty();

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

@@ -1 +1 @@
-{"version":3,"file":"HttpBody.js","names":["Data","Effect","FileSystem","format","Inspectable","Predicate","Schema","Parser","UrlParams","TypeId","isHttpBody","u","hasProperty","HttpBodyErrorTypeId","HttpBodyError","TaggedError","Proto","constructor","NodeInspectSymbol","toJSON","toString","ignoreToString","Empty","_tag","_id","empty","Raw","body","contentType","contentLength","raw","options","Uint8Array","startsWith","endsWith","TextDecoder","decode","length","uint8Array","encoder","TextEncoder","text","encode","jsonUnsafe","JSON","stringify","json","try","catch","cause","reason","jsonSchema","schema","encodeUnknownEffect","toCodecJson","pipe","mapError","issue","flatMap","urlParams","FormData","undefined","formData","appendFormDataValue","key","value","append","String","formDataRecord","entries","data","globalThis","Object","Array","isArray","item","Stream","stream","file","path","fs","map","stat","info","Number","size","fileFromInfo"],"sources":["../../../src/unstable/http/HttpBody.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;AAiBA,OAAO,KAAKA,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,UAAU,MAAM,qBAAqB;AACjD,SAASC,MAAM,QAAQ,oBAAoB;AAC3C,OAAO,KAAKC,WAAW,MAAM,sBAAsB;AAEnD,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAGzC,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C,MAAMC,MAAM,GAAG,uBAAuB;AAEtC;;;;;;AAMA,OAAO,MAAMC,UAAU,GAAIC,CAAU,IAAoBN,SAAS,CAACO,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AAoDzF,MAAMI,mBAAmB,GAAG,qCAAqC;AAEjE;;;;;;AAMA,OAAM,MAAOC,aAAc,sBAAQd,IAAI,CAACe,WAAW,CAAC,eAAe,CAGjE;EACA;;;;;EAKS,CAACF,mBAAmB,IAAIA,mBAAmB;;AAoBtD,MAAeG,KAAK;EACT,CAACP,MAAM;EAEhBQ,YAAA;IACE,IAAI,CAACR,MAAM,CAAC,GAAGA,MAAM;EACvB;EAEA,CAACL,WAAW,CAACc,iBAAiB,IAAC;IAC7B,OAAO,IAAI,CAACC,MAAM,EAAE;EACtB;EACAC,QAAQA,CAAA;IACN,OAAOjB,MAAM,CAAC,IAAI,EAAE;MAAEkB,cAAc,EAAE;IAAI,CAAE,CAAC;EAC/C;;AAGF;;;;;;AAMA,OAAM,MAAOC,KAAM,SAAQN,KAAK;EACrBO,IAAI,GAAG,OAAO;EACvBJ,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE;KACP;EACH;;AAGF;;;;;;AAMA,OAAO,MAAME,KAAK,gBAAU,IAAIH,KAAK,EAAE;AAEvC;;;;;;AAMA,OAAM,MAAOI,GAAI,SAAQV,KAAK;EACnBO,IAAI,GAAG,KAAK;EACZI,IAAI;EACJC,WAAW;EACXC,aAAa;EAEtBZ,YACEU,IAAa,EACbC,WAA+B,EAC/BC,aAAiC;IAEjC,KAAK,EAAE;IACP,IAAI,CAACF,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,aAAa,GAAGA,aAAa;EACpC;EACAV,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,KAAK;MACXI,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,WAAW,EAAE,IAAI,CAACA,WAAW;MAC7BC,aAAa,EAAE,IAAI,CAACA;KACrB;EACH;;AAGF;;;;;;AAMA,OAAO,MAAMC,GAAG,GAAGA,CACjBH,IAAa,EACbI,OAGa,KACL,IAAIL,GAAG,CAACC,IAAI,EAAEI,OAAO,EAAEH,WAAW,EAAEG,OAAO,EAAEF,aAAa,CAAC;AAErE;;;;;;;;;;AAUA,OAAM,MAAOG,UAAW,SAAQhB,KAAK;EAC1BO,IAAI,GAAG,YAAY;EACnBI,IAAI;EACJC,WAAW;EACXC,aAAa;EAEtBZ,YACEU,IAA2B,EAC3BC,WAAmB,EACnBC,aAAqB;IAErB,KAAK,EAAE;IACP,IAAI,CAACF,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,aAAa,GAAGA,aAAa;EACpC;EACAV,MAAMA,CAAA;IACJ,MAAMC,QAAQ,GAAG,IAAI,CAACQ,WAAW,CAACK,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAACL,WAAW,CAACM,QAAQ,CAAC,MAAM,CAAC;IAC1F,OAAO;MACLV,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,YAAY;MAClBI,IAAI,EAAEP,QAAQ,GAAG,IAAIe,WAAW,EAAE,CAACC,MAAM,CAAC,IAAI,CAACT,IAAI,CAAC,GAAG,cAAc,IAAI,CAACA,IAAI,CAACU,MAAM,GAAG;MACxFT,WAAW,EAAE,IAAI,CAACA,WAAW;MAC7BC,aAAa,EAAE,IAAI,CAACA;KACrB;EACH;;AAGF;;;;;;;;;;AAUA,OAAO,MAAMS,UAAU,GAAGA,CAACX,IAA2B,EAAEC,WAAoB,KAC1E,IAAII,UAAU,CAACL,IAAI,EAAEC,WAAW,IAAI,0BAA0B,EAAED,IAAI,CAACU,MAAM,CAAC;AAE9E,MAAME,OAAO,gBAAG,IAAIC,WAAW,EAAE;AAEjC;;;;;;;;;;AAUA,OAAO,MAAMC,IAAI,GAAGA,CAACd,IAAY,EAAEC,WAAoB,KACrDU,UAAU,CAACC,OAAO,CAACG,MAAM,CAACf,IAAI,CAAC,EAAEC,WAAW,IAAI,YAAY,CAAC;AAE/D;;;;;;;;;;AAUA,OAAO,MAAMe,UAAU,GAAGA,CAAChB,IAAa,EAAEC,WAAoB,KAC5Da,IAAI,CAACG,IAAI,CAACC,SAAS,CAAClB,IAAI,CAAC,EAAEC,WAAW,IAAI,kBAAkB,CAAC;AAE/D;;;;;;;;;;AAUA,OAAO,MAAMkB,IAAI,GAAGA,CAACnB,IAAa,EAAEC,WAAoB,KACtD3B,MAAM,CAAC8C,GAAG,CAAC;EACTA,GAAG,EAAEA,CAAA,KAAMN,IAAI,CAACG,IAAI,CAACC,SAAS,CAAClB,IAAI,CAAC,EAAEC,WAAW,IAAI,kBAAkB,CAAC;EACxEoB,KAAK,EAAGC,KAAK,IAAK,IAAInC,aAAa,CAAC;IAAEoC,MAAM,EAAE;MAAE3B,IAAI,EAAE;IAAW,CAAE;IAAE0B;EAAK,CAAE;CAC7E,CAAC;AAEJ;;;;;;;;;;AAUA,OAAO,MAAME,UAAU,GAAGA,CACxBC,MAAS,EACTrB,OAAkC,KAChC;EACF,MAAMW,MAAM,GAAGnC,MAAM,CAAC8C,mBAAmB,CAAC/C,MAAM,CAACgD,WAAW,CAACF,MAAM,CAAC,CAAC;EACrE,OAAO,CAACzB,IAAe,EAAEC,WAAoB,KAC3Cc,MAAM,CAACf,IAAI,EAAEI,OAAO,CAAC,CAACwB,IAAI,CACxBtD,MAAM,CAACuD,QAAQ,CAAEC,KAAK,IAAK,IAAI3C,aAAa,CAAC;IAAEoC,MAAM,EAAE;MAAE3B,IAAI,EAAE,aAAa;MAAEkC;IAAK,CAAE;IAAER,KAAK,EAAEQ;EAAK,CAAE,CAAC,CAAC,EACvGxD,MAAM,CAACyD,OAAO,CAAE/B,IAAI,IAAKmB,IAAI,CAACnB,IAAI,EAAEC,WAAW,CAAC,CAAC,CAClD;AACL,CAAC;AAED;;;;;;AAMA,OAAO,MAAM+B,SAAS,GAAGA,CAACA,SAA8B,EAAE/B,WAAoB,KAC5Ea,IAAI,CAACjC,SAAS,CAACY,QAAQ,CAACuC,SAAS,CAAC,EAAE/B,WAAW,IAAI,mCAAmC,CAAC;AAEzF;;;;;;;;;;AAUA,OAAM,MAAOgC,QAAS,SAAQ5C,KAAK;EACxBO,IAAI,GAAG,UAAU;EACjBK,WAAW,GAAGiC,SAAS;EACvBhC,aAAa,GAAGgC,SAAS;EACzBC,QAAQ;EAEjB7C,YACE6C,QAA6B;IAE7B,KAAK,EAAE;IACP,IAAI,CAACA,QAAQ,GAAGA,QAAQ;EAC1B;EACA3C,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,UAAU;MAChBuC,QAAQ,EAAE,IAAI,CAACA;KAChB;EACH;;AAGF;;;;;;AAMA,OAAO,MAAMA,QAAQ,GAAInC,IAAyB,IAAe,IAAIiC,QAAQ,CAACjC,IAAI,CAAC;AA0BnF,MAAMoC,mBAAmB,GAAGA,CAACD,QAA6B,EAAEE,GAAW,EAAEC,KAAwB,KAAU;EACzG,IAAIA,KAAK,IAAI,IAAI,EAAE;IACjB;EACF;EACA,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;IAC7BH,QAAQ,CAACI,MAAM,CAACF,GAAG,EAAEC,KAAK,CAAC;IAC3B;EACF;EACAH,QAAQ,CAACI,MAAM,CAACF,GAAG,EAAEG,MAAM,CAACF,KAAK,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;AAUA,OAAO,MAAMG,cAAc,GAAIC,OAAsB,IAAc;EACjE,MAAMC,IAAI,GAAG,IAAIC,UAAU,CAACX,QAAQ,EAAE;EACtC,KAAK,MAAM,CAACI,GAAG,EAAEC,KAAK,CAAC,IAAIO,MAAM,CAACH,OAAO,CAACA,OAAO,CAAC,EAAE;IAClD,IAAII,KAAK,CAACC,OAAO,CAACT,KAAK,CAAC,EAAE;MACxB,KAAK,MAAMU,IAAI,IAAIV,KAAK,EAAE;QACxBF,mBAAmB,CAACO,IAAI,EAAEN,GAAG,EAAEW,IAAI,CAAC;MACtC;IACF,CAAC,MAAM;MACLZ,mBAAmB,CAACO,IAAI,EAAEN,GAAG,EAAEC,KAA0B,CAAC;IAC5D;EACF;EACA,OAAOH,QAAQ,CAACQ,IAAI,CAAC;AACvB,CAAC;AAED;;;;;;AAMA,OAAM,MAAOM,MAAO,SAAQ5D,KAAK;EACtBO,IAAI,GAAG,QAAQ;EACfsD,MAAM;EACNjD,WAAW;EACXC,aAAa;EAEtBZ,YACE4D,MAAsD,EACtDjD,WAAmB,EACnBC,aAAiC;IAEjC,KAAK,EAAE;IACP,IAAI,CAACgD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACjD,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,aAAa,GAAGA,aAAa;EACpC;EACAV,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,QAAQ;MACdK,WAAW,EAAE,IAAI,CAACA,WAAW;MAC7BC,aAAa,EAAE,IAAI,CAACA;KACrB;EACH;;AAGF;;;;;;;;;;AAUA,OAAO,MAAMgD,MAAM,GAAGA,CACpBlD,IAAoD,EACpDC,WAAoB,EACpBC,aAAsB,KACX,IAAI+C,MAAM,CAACjD,IAAI,EAAEC,WAAW,IAAI,0BAA0B,EAAEC,aAAa,CAAC;AAEvF;;;;;;;;;;AAUA,OAAO,MAAMiD,IAAI,GAAGA,CAClBC,IAAY,EACZhD,OAKC,KAED9B,MAAM,CAACyD,OAAO,CACZxD,UAAU,CAACA,UAAU,EACpB8E,EAAE,IACD/E,MAAM,CAACgF,GAAG,CAACD,EAAE,CAACE,IAAI,CAACH,IAAI,CAAC,EAAGI,IAAI,IAC7BN,MAAM,CACJG,EAAE,CAACH,MAAM,CAACE,IAAI,EAAEhD,OAAO,CAAC,EACxBA,OAAO,EAAEH,WAAW,EACpBwD,MAAM,CAACD,IAAI,CAACE,IAAI,CAAC,CAClB,CAAC,CACP;AAEH;;;;;;;;;;AAUA,OAAO,MAAMC,YAAY,GAAGA,CAC1BP,IAAY,EACZI,IAA0B,EAC1BpD,OAKC,KAED9B,MAAM,CAACgF,GAAG,CACR/E,UAAU,CAACA,UAAU,EACpB8E,EAAE,IACDH,MAAM,CACJG,EAAE,CAACH,MAAM,CAACE,IAAI,EAAEhD,OAAO,CAAC,EACxBA,OAAO,EAAEH,WAAW,EACpBwD,MAAM,CAACD,IAAI,CAACE,IAAI,CAAC,CAClB,CACJ","ignoreList":[]}
+{"version":3,"file":"HttpBody.js","names":["Data","Effect","FileSystem","format","Inspectable","Predicate","Schema","Parser","UrlParams","TypeId","isHttpBody","u","hasProperty","HttpBodyErrorTypeId","HttpBodyError","TaggedError","Proto","constructor","NodeInspectSymbol","toJSON","toString","ignoreToString","Empty","_tag","_id","empty","Raw","body","contentType","contentLength","raw","options","Uint8Array","startsWith","endsWith","TextDecoder","decode","length","uint8Array","encoder","TextEncoder","text","encode","jsonUnsafe","JSON","stringify","json","try","catch","cause","reason","jsonSchema","schema","encodeUnknownEffect","toCodecJson","pipe","mapError","issue","flatMap","urlParams","FormData","undefined","formData","appendFormDataValue","key","value","append","String","formDataRecord","entries","data","globalThis","Object","Array","isArray","item","Stream","stream","file","path","fs","map","stat","info","Number","size","fileFromInfo"],"sources":["../../../src/unstable/http/HttpBody.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDA,OAAO,KAAKA,IAAI,MAAM,eAAe;AACrC,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,UAAU,MAAM,qBAAqB;AACjD,SAASC,MAAM,QAAQ,oBAAoB;AAC3C,OAAO,KAAKC,WAAW,MAAM,sBAAsB;AAEnD,OAAO,KAAKC,SAAS,MAAM,oBAAoB;AAC/C,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AAGzC,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAE/C,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C,MAAMC,MAAM,GAAG,uBAAuB;AAEtC;;;;;;AAMA,OAAO,MAAMC,UAAU,GAAIC,CAAU,IAAoBN,SAAS,CAACO,WAAW,CAACD,CAAC,EAAEF,MAAM,CAAC;AAoDzF,MAAMI,mBAAmB,GAAG,qCAAqC;AAEjE;;;;;;AAMA,OAAM,MAAOC,aAAc,sBAAQd,IAAI,CAACe,WAAW,CAAC,eAAe,CAGjE;EACA;;;;;EAKS,CAACF,mBAAmB,IAAIA,mBAAmB;;AAoBtD,MAAeG,KAAK;EACT,CAACP,MAAM;EAEhBQ,YAAA;IACE,IAAI,CAACR,MAAM,CAAC,GAAGA,MAAM;EACvB;EAEA,CAACL,WAAW,CAACc,iBAAiB,IAAC;IAC7B,OAAO,IAAI,CAACC,MAAM,EAAE;EACtB;EACAC,QAAQA,CAAA;IACN,OAAOjB,MAAM,CAAC,IAAI,EAAE;MAAEkB,cAAc,EAAE;IAAI,CAAE,CAAC;EAC/C;;AAGF;;;;;;AAMA,OAAM,MAAOC,KAAM,SAAQN,KAAK;EACrBO,IAAI,GAAG,OAAO;EACvBJ,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE;KACP;EACH;;AAGF;;;;;;;;;;AAUA,OAAO,MAAME,KAAK,gBAAU,IAAIH,KAAK,EAAE;AAEvC;;;;;;AAMA,OAAM,MAAOI,GAAI,SAAQV,KAAK;EACnBO,IAAI,GAAG,KAAK;EACZI,IAAI;EACJC,WAAW;EACXC,aAAa;EAEtBZ,YACEU,IAAa,EACbC,WAA+B,EAC/BC,aAAiC;IAEjC,KAAK,EAAE;IACP,IAAI,CAACF,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,aAAa,GAAGA,aAAa;EACpC;EACAV,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,KAAK;MACXI,IAAI,EAAE,IAAI,CAACA,IAAI;MACfC,WAAW,EAAE,IAAI,CAACA,WAAW;MAC7BC,aAAa,EAAE,IAAI,CAACA;KACrB;EACH;;AAGF;;;;;;AAMA,OAAO,MAAMC,GAAG,GAAGA,CACjBH,IAAa,EACbI,OAGa,KACL,IAAIL,GAAG,CAACC,IAAI,EAAEI,OAAO,EAAEH,WAAW,EAAEG,OAAO,EAAEF,aAAa,CAAC;AAErE;;;;;;;;;;AAUA,OAAM,MAAOG,UAAW,SAAQhB,KAAK;EAC1BO,IAAI,GAAG,YAAY;EACnBI,IAAI;EACJC,WAAW;EACXC,aAAa;EAEtBZ,YACEU,IAA2B,EAC3BC,WAAmB,EACnBC,aAAqB;IAErB,KAAK,EAAE;IACP,IAAI,CAACF,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,aAAa,GAAGA,aAAa;EACpC;EACAV,MAAMA,CAAA;IACJ,MAAMC,QAAQ,GAAG,IAAI,CAACQ,WAAW,CAACK,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAACL,WAAW,CAACM,QAAQ,CAAC,MAAM,CAAC;IAC1F,OAAO;MACLV,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,YAAY;MAClBI,IAAI,EAAEP,QAAQ,GAAG,IAAIe,WAAW,EAAE,CAACC,MAAM,CAAC,IAAI,CAACT,IAAI,CAAC,GAAG,cAAc,IAAI,CAACA,IAAI,CAACU,MAAM,GAAG;MACxFT,WAAW,EAAE,IAAI,CAACA,WAAW;MAC7BC,aAAa,EAAE,IAAI,CAACA;KACrB;EACH;;AAGF;;;;;;;;;;AAUA,OAAO,MAAMS,UAAU,GAAGA,CAACX,IAA2B,EAAEC,WAAoB,KAC1E,IAAII,UAAU,CAACL,IAAI,EAAEC,WAAW,IAAI,0BAA0B,EAAED,IAAI,CAACU,MAAM,CAAC;AAE9E,MAAME,OAAO,gBAAG,IAAIC,WAAW,EAAE;AAEjC;;;;;;;;;;AAUA,OAAO,MAAMC,IAAI,GAAGA,CAACd,IAAY,EAAEC,WAAoB,KACrDU,UAAU,CAACC,OAAO,CAACG,MAAM,CAACf,IAAI,CAAC,EAAEC,WAAW,IAAI,YAAY,CAAC;AAE/D;;;;;;;;;;AAUA,OAAO,MAAMe,UAAU,GAAGA,CAAChB,IAAa,EAAEC,WAAoB,KAC5Da,IAAI,CAACG,IAAI,CAACC,SAAS,CAAClB,IAAI,CAAC,EAAEC,WAAW,IAAI,kBAAkB,CAAC;AAE/D;;;;;;;;;;AAUA,OAAO,MAAMkB,IAAI,GAAGA,CAACnB,IAAa,EAAEC,WAAoB,KACtD3B,MAAM,CAAC8C,GAAG,CAAC;EACTA,GAAG,EAAEA,CAAA,KAAMN,IAAI,CAACG,IAAI,CAACC,SAAS,CAAClB,IAAI,CAAC,EAAEC,WAAW,IAAI,kBAAkB,CAAC;EACxEoB,KAAK,EAAGC,KAAK,IAAK,IAAInC,aAAa,CAAC;IAAEoC,MAAM,EAAE;MAAE3B,IAAI,EAAE;IAAW,CAAE;IAAE0B;EAAK,CAAE;CAC7E,CAAC;AAEJ;;;;;;;;;;AAUA,OAAO,MAAME,UAAU,GAAGA,CACxBC,MAAS,EACTrB,OAAkC,KAChC;EACF,MAAMW,MAAM,GAAGnC,MAAM,CAAC8C,mBAAmB,CAAC/C,MAAM,CAACgD,WAAW,CAACF,MAAM,CAAC,CAAC;EACrE,OAAO,CAACzB,IAAe,EAAEC,WAAoB,KAC3Cc,MAAM,CAACf,IAAI,EAAEI,OAAO,CAAC,CAACwB,IAAI,CACxBtD,MAAM,CAACuD,QAAQ,CAAEC,KAAK,IAAK,IAAI3C,aAAa,CAAC;IAAEoC,MAAM,EAAE;MAAE3B,IAAI,EAAE,aAAa;MAAEkC;IAAK,CAAE;IAAER,KAAK,EAAEQ;EAAK,CAAE,CAAC,CAAC,EACvGxD,MAAM,CAACyD,OAAO,CAAE/B,IAAI,IAAKmB,IAAI,CAACnB,IAAI,EAAEC,WAAW,CAAC,CAAC,CAClD;AACL,CAAC;AAED;;;;;;AAMA,OAAO,MAAM+B,SAAS,GAAGA,CAACA,SAA8B,EAAE/B,WAAoB,KAC5Ea,IAAI,CAACjC,SAAS,CAACY,QAAQ,CAACuC,SAAS,CAAC,EAAE/B,WAAW,IAAI,mCAAmC,CAAC;AAEzF;;;;;;;;;;AAUA,OAAM,MAAOgC,QAAS,SAAQ5C,KAAK;EACxBO,IAAI,GAAG,UAAU;EACjBK,WAAW,GAAGiC,SAAS;EACvBhC,aAAa,GAAGgC,SAAS;EACzBC,QAAQ;EAEjB7C,YACE6C,QAA6B;IAE7B,KAAK,EAAE;IACP,IAAI,CAACA,QAAQ,GAAGA,QAAQ;EAC1B;EACA3C,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,UAAU;MAChBuC,QAAQ,EAAE,IAAI,CAACA;KAChB;EACH;;AAGF;;;;;;AAMA,OAAO,MAAMA,QAAQ,GAAInC,IAAyB,IAAe,IAAIiC,QAAQ,CAACjC,IAAI,CAAC;AA0BnF,MAAMoC,mBAAmB,GAAGA,CAACD,QAA6B,EAAEE,GAAW,EAAEC,KAAwB,KAAU;EACzG,IAAIA,KAAK,IAAI,IAAI,EAAE;IACjB;EACF;EACA,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;IAC7BH,QAAQ,CAACI,MAAM,CAACF,GAAG,EAAEC,KAAK,CAAC;IAC3B;EACF;EACAH,QAAQ,CAACI,MAAM,CAACF,GAAG,EAAEG,MAAM,CAACF,KAAK,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;AAUA,OAAO,MAAMG,cAAc,GAAIC,OAAsB,IAAc;EACjE,MAAMC,IAAI,GAAG,IAAIC,UAAU,CAACX,QAAQ,EAAE;EACtC,KAAK,MAAM,CAACI,GAAG,EAAEC,KAAK,CAAC,IAAIO,MAAM,CAACH,OAAO,CAACA,OAAO,CAAC,EAAE;IAClD,IAAII,KAAK,CAACC,OAAO,CAACT,KAAK,CAAC,EAAE;MACxB,KAAK,MAAMU,IAAI,IAAIV,KAAK,EAAE;QACxBF,mBAAmB,CAACO,IAAI,EAAEN,GAAG,EAAEW,IAAI,CAAC;MACtC;IACF,CAAC,MAAM;MACLZ,mBAAmB,CAACO,IAAI,EAAEN,GAAG,EAAEC,KAA0B,CAAC;IAC5D;EACF;EACA,OAAOH,QAAQ,CAACQ,IAAI,CAAC;AACvB,CAAC;AAED;;;;;;AAMA,OAAM,MAAOM,MAAO,SAAQ5D,KAAK;EACtBO,IAAI,GAAG,QAAQ;EACfsD,MAAM;EACNjD,WAAW;EACXC,aAAa;EAEtBZ,YACE4D,MAAsD,EACtDjD,WAAmB,EACnBC,aAAiC;IAEjC,KAAK,EAAE;IACP,IAAI,CAACgD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACjD,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,aAAa,GAAGA,aAAa;EACpC;EACAV,MAAMA,CAAA;IACJ,OAAO;MACLK,GAAG,EAAE,iBAAiB;MACtBD,IAAI,EAAE,QAAQ;MACdK,WAAW,EAAE,IAAI,CAACA,WAAW;MAC7BC,aAAa,EAAE,IAAI,CAACA;KACrB;EACH;;AAGF;;;;;;;;;;AAUA,OAAO,MAAMgD,MAAM,GAAGA,CACpBlD,IAAoD,EACpDC,WAAoB,EACpBC,aAAsB,KACX,IAAI+C,MAAM,CAACjD,IAAI,EAAEC,WAAW,IAAI,0BAA0B,EAAEC,aAAa,CAAC;AAEvF;;;;;;;;;;AAUA,OAAO,MAAMiD,IAAI,GAAGA,CAClBC,IAAY,EACZhD,OAKC,KAED9B,MAAM,CAACyD,OAAO,CACZxD,UAAU,CAACA,UAAU,EACpB8E,EAAE,IACD/E,MAAM,CAACgF,GAAG,CAACD,EAAE,CAACE,IAAI,CAACH,IAAI,CAAC,EAAGI,IAAI,IAC7BN,MAAM,CACJG,EAAE,CAACH,MAAM,CAACE,IAAI,EAAEhD,OAAO,CAAC,EACxBA,OAAO,EAAEH,WAAW,EACpBwD,MAAM,CAACD,IAAI,CAACE,IAAI,CAAC,CAClB,CAAC,CACP;AAEH;;;;;;;;;;AAUA,OAAO,MAAMC,YAAY,GAAGA,CAC1BP,IAAY,EACZI,IAA0B,EAC1BpD,OAKC,KAED9B,MAAM,CAACgF,GAAG,CACR/E,UAAU,CAACA,UAAU,EACpB8E,EAAE,IACDH,MAAM,CACJG,EAAE,CAACH,MAAM,CAACE,IAAI,EAAEhD,OAAO,CAAC,EACxBA,OAAO,EAAEH,WAAW,EACpBwD,MAAM,CAACD,IAAI,CAACE,IAAI,CAAC,CAClB,CACJ","ignoreList":[]}

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

@@ -1,22 +1,38 @@
 /**
- * Composable HTTP client service for executing `HttpClientRequest` values and
- * receiving `HttpClientResponse` values inside Effect programs.
+ * Dependency-injected HTTP client for executing outgoing requests from Effect
+ * programs.
  *
- * This module provides the `HttpClient` service tag, method-specific accessors,
- * constructors for low-level runtimes, and middleware-style combinators for
- * common client concerns such as request rewriting, response filtering, retries,
- * redirects, cookies, rate limiting, and tracing. It is intended for code that
- * needs dependency-injected outbound HTTP calls, reusable clients customized for
- * an API, or cross-cutting behavior layered around a concrete platform client.
+ * This module defines the `HttpClient` service used by platform clients,
+ * tests, and API-specific clients. It executes immutable `HttpClientRequest`
+ * values, returns `HttpClientResponse` values, and keeps outbound HTTP behind a
+ * service boundary so call sites do not depend on a concrete runtime transport.
  *
- * Responses are successful Effects even for non-2xx status codes unless a
- * filter such as `filterStatus` or `filterStatusOk` is applied. Request
- * middleware is ordered by whether it prepends to or appends after the existing
- * preprocessing pipeline, so use `mapRequestInput` for transformations that
- * should run before previously installed request middleware and `mapRequest`
- * for transformations that should run after it. Non-scoped responses are tied to
- * an abort controller for interruption cleanup; use `withScope` when the request
- * lifetime should instead be controlled by a surrounding `Scope`.
+ * **Mental model**
+ *
+ * A client is an `execute` function plus method helpers such as `get`, `post`,
+ * and `del`. Before a request reaches the runtime, it passes through a
+ * preprocessing pipeline. After the runtime returns a response, it passes
+ * through a postprocessing pipeline. Combinators such as `mapRequest`,
+ * `filterStatusOk`, `retry`, `followRedirects`, `withCookiesRef`, and
+ * `withRateLimiter` return a new client with behavior layered around the
+ * previous one.
+ *
+ * **Common tasks**
+ *
+ * Use method helpers for straightforward calls, construct `HttpClientRequest`
+ * values directly when a request is assembled across several steps, and use
+ * `make` or `makeWith` when adapting a lower-level transport. Use
+ * `filterStatus` or `filterStatusOk` when non-success HTTP statuses should fail
+ * the Effect. Use `withScope` when response resources should live for a
+ * surrounding scope instead of only the individual request.
+ *
+ * **Gotchas**
+ *
+ * Receiving a response is a successful Effect even for non-2xx statuses unless
+ * a status filter has been applied. `mapRequestInput` prepends work before
+ * existing request middleware, while `mapRequest` appends after it. Without
+ * `withScope`, non-scoped responses are attached to an abort controller so
+ * interruption can clean up the request.
  *
  * @since 4.0.0
  */
@@ -99,7 +115,12 @@ export declare namespace HttpClient {
     type Postprocess<E = never, R = never> = (request: Effect.Effect<HttpClientRequest.HttpClientRequest, E, R>) => Effect.Effect<HttpClientResponse.HttpClientResponse, E, R>;
 }
 /**
- * Service tag for the default `HttpClient` used by HTTP client accessors.
+ * Service tag for the default outgoing HTTP client service.
+ *
+ * **When to use**
+ *
+ * Use to provide the HTTP client implementation consumed by the module's
+ * request accessor functions.
  *
  * @category tags
  * @since 4.0.0
@@ -593,7 +614,7 @@ export declare const retry: {
  *
  * **When to use**
  *
- * Use `retryOn` to focus on retrying errors, transient responses, or both.
+ * Use to focus on retrying errors, transient responses, or both.
  *
  * **Details**
  *
@@ -609,7 +630,7 @@ export declare const retryTransient: {
      *
      * **When to use**
      *
-     * Use `retryOn` to focus on retrying errors, transient responses, or both.
+     * Use to focus on retrying errors, transient responses, or both.
      *
      * **Details**
      *
@@ -630,7 +651,7 @@ export declare const retryTransient: {
      *
      * **When to use**
      *
-     * Use `retryOn` to focus on retrying errors, transient responses, or both.
+     * Use to focus on retrying errors, transient responses, or both.
      *
      * **Details**
      *
@@ -651,7 +672,7 @@ export declare const retryTransient: {
      *
      * **When to use**
      *
-     * Use `retryOn` to focus on retrying errors, transient responses, or both.
+     * Use to focus on retrying errors, transient responses, or both.
      *
      * **Details**
      *
@@ -667,7 +688,7 @@ export declare const retryTransient: {
      *
      * **When to use**
      *
-     * Use `retryOn` to focus on retrying errors, transient responses, or both.
+     * Use to focus on retrying errors, transient responses, or both.
      *
      * **Details**
      *
@@ -835,21 +856,36 @@ export declare const tapRequest: {
     <E, R, _, E2, R2>(self: HttpClient.With<E, R>, f: (a: HttpClientRequest.HttpClientRequest) => Effect.Effect<_, E2, R2>): HttpClient.With<E | E2, R | R2>;
 };
 /**
- * Associates a `Ref` of cookies with the client for handling cookies across requests.
+ * Adds a `Ref` of cookies to the client for handling cookies across requests.
+ *
+ * **When to use**
+ *
+ * Use to add shared cookie storage to a client so response cookies are retained
+ * and sent by later requests.
  *
  * @category cookies
  * @since 4.0.0
  */
 export declare const withCookiesRef: {
     /**
-     * Associates a `Ref` of cookies with the client for handling cookies across requests.
+     * Adds a `Ref` of cookies to the client for handling cookies across requests.
+     *
+     * **When to use**
+     *
+     * Use to add shared cookie storage to a client so response cookies are retained
+     * and sent by later requests.
      *
      * @category cookies
      * @since 4.0.0
      */
     (ref: Ref.Ref<Cookies.Cookies>): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E, R>;
     /**
-     * Associates a `Ref` of cookies with the client for handling cookies across requests.
+     * Adds a `Ref` of cookies to the client for handling cookies across requests.
+     *
+     * **When to use**
+     *
+     * Use to add shared cookie storage to a client so response cookies are retained
+     * and sent by later requests.
      *
      * @category cookies
      * @since 4.0.0
@@ -857,28 +893,28 @@ export declare const withCookiesRef: {
     <E, R>(self: HttpClient.With<E, R>, ref: Ref.Ref<Cookies.Cookies>): HttpClient.With<E, R>;
 };
 /**
- * Ties the lifetime of the `HttpClientRequest` to a `Scope`.
+ * Attaches the lifetime of the `HttpClientRequest` to a `Scope`.
  *
- * @category Scope
+ * @category resource management
  * @since 4.0.0
  */
 export declare const withScope: <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E, R | Scope.Scope>;
 /**
- * Follows HTTP redirects up to a specified number of times.
+ * Enables following HTTP redirects up to a specified number of times.
  *
  * @category redirects
  * @since 4.0.0
  */
 export declare const followRedirects: {
     /**
-     * Follows HTTP redirects up to a specified number of times.
+     * Enables following HTTP redirects up to a specified number of times.
      *
      * @category redirects
      * @since 4.0.0
      */
     (maxRedirects?: number | undefined): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E, R>;
     /**
-     * Follows HTTP redirects up to a specified number of times.
+     * Enables following HTTP redirects up to a specified number of times.
      *
      * @category redirects
      * @since 4.0.0