effect 4.0.0-beta.73 → 4.0.0-beta.74

package/dist/Schema.js

@@ -240,7 +240,7 @@ export function declare(is, annotations) {
  * type E = typeof bottom["Encoded"]  // string
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 4.0.0
  */
 export function revealBottom(bottom) {
@@ -367,7 +367,7 @@ export function annotateKey(annotations) {
  * type Enc = typeof codec["Encoded"] // string
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 4.0.0
  */
 export function revealCodec(codec) {
@@ -1560,7 +1560,7 @@ export const Number = /*#__PURE__*/make(AST.number);
  *
  * @see {@link BooleanFromBit} for a schema that decodes bit literals `0` or `1` into a boolean
  *
- * @category Boolean
+ * @category boolean
  * @since 4.0.0
  */
 export const Boolean = /*#__PURE__*/make(AST.boolean);
@@ -2989,7 +2989,7 @@ export function link() {
  * //   at ["c"])]))
  * ```
  *
- * @category Checks Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeFilter = AST.makeFilter;
@@ -2997,7 +2997,7 @@ export const makeFilter = AST.makeFilter;
  * Groups multiple checks into a single {@link AST.FilterGroup}, applying
  * optional shared annotations to the group as a whole.
  *
- * @category Checks Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function makeFilterGroup(checks, annotations = undefined) {
@@ -4730,7 +4730,7 @@ export function isUnique(annotations) {
  * Schema for non-empty strings. Validates that a string has at least one
  * character.
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const NonEmptyString = /*#__PURE__*/String.check(/*#__PURE__*/isNonEmpty());
@@ -4750,7 +4750,7 @@ export const NonEmptyString = /*#__PURE__*/String.check(/*#__PURE__*/isNonEmpty(
  * @see {@link NonEmptyString} for strings with length greater than zero
  * @see {@link isLengthBetween} for the underlying length check
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const Char = /*#__PURE__*/String.check(/*#__PURE__*/isLengthBetween(1, 1));
@@ -6117,7 +6117,7 @@ export const BigDecimalFromString = /*#__PURE__*/BigDecimalString.pipe(/*#__PURE
  * // => { a: 1, b: 2 }
  * ```
  *
- * @category JSON
+ * @category schemas
  * @since 4.0.0
  */
 export const UnknownFromJsonString = /*#__PURE__*/fromJsonString(Unknown);
@@ -6184,7 +6184,7 @@ export const UnknownFromJsonString = /*#__PURE__*/fromJsonString(Unknown);
  * // }
  * ```
  *
- * @category JSON
+ * @category constructors
  * @since 4.0.0
  */
 export function fromJsonString(schema) {
@@ -6202,7 +6202,7 @@ export function fromJsonString(schema) {
  * The default JSON serializer encodes a `File` as `{ data, type, name, lastModified }`
  * where `data` is base64-encoded.
  *
- * @category File
+ * @category file
  * @since 4.0.0
  */
 export const File = /*#__PURE__*/instanceOf(globalThis.File, {
@@ -6397,7 +6397,7 @@ export function fromFormData(schema) {
  *
  * The default JSON serializer encodes a `URLSearchParams` as a query string.
  *
- * @category URLSearchParams
+ * @category search params
  * @since 4.0.0
  */
 export const URLSearchParams = /*#__PURE__*/instanceOf(globalThis.URLSearchParams, {
@@ -6583,7 +6583,7 @@ export const BigIntFromString = /*#__PURE__*/make(AST.bigIntString).pipe(/*#__PU
 /**
  * Schema for strings that contains no leading or trailing whitespaces.
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const Trimmed = /*#__PURE__*/String.check(/*#__PURE__*/isTrimmed());
@@ -6598,7 +6598,7 @@ export const Trimmed = /*#__PURE__*/String.check(/*#__PURE__*/isTrimmed());
  * Encoding:
  * - The trimmed string is encoded as is.
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const Trim = /*#__PURE__*/String.annotate({
@@ -6615,7 +6615,7 @@ export const Trim = /*#__PURE__*/String.annotate({
  * Encoding:
  * - A `string` is encoded as a base64-encoded string.
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const StringFromBase64 = /*#__PURE__*/String.annotate({
@@ -6632,7 +6632,7 @@ export const StringFromBase64 = /*#__PURE__*/String.annotate({
  * Encoding:
  * - A `string` is encoded as a base64 (URL) encoded string.
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const StringFromBase64Url = /*#__PURE__*/String.annotate({
@@ -6649,7 +6649,7 @@ export const StringFromBase64Url = /*#__PURE__*/String.annotate({
  * Encoding:
  * - A `string` is encoded as a hex string.
  *
- * @category String
+ * @category string
  * @since 3.10.0
  */
 export const StringFromHex = /*#__PURE__*/String.annotate({
@@ -6685,7 +6685,7 @@ export const StringFromHex = /*#__PURE__*/String.annotate({
  * // %7B%22maxItemPerPage%22%3A10%2C%22page%22%3A1%7D
  * ```
  *
- * @category String
+ * @category string
  * @since 3.12.0
  */
 export const StringFromUriComponent = /*#__PURE__*/String.annotate({
@@ -6707,7 +6707,7 @@ export const PropertyKey = /*#__PURE__*/Union([Finite, Symbol, String]);
  * The result contains an `issues` array where each issue has a message and an
  * optional path made of property keys or keyed path segments.
  *
- * @category StandardSchema
+ * @category Standard Schema
  * @since 4.0.0
  */
 export const StandardSchemaV1FailureResult = /*#__PURE__*/Struct({
@@ -6734,7 +6734,7 @@ export const StandardSchemaV1FailureResult = /*#__PURE__*/Struct({
  * @see {@link Boolean} for validating values that are already booleans
  * @see {@link Literals} for keeping bit literals instead of decoding them
  *
- * @category Boolean
+ * @category boolean
  * @since 4.0.0
  */
 export const BooleanFromBit = /*#__PURE__*/Literals([0, 1]).pipe(/*#__PURE__*/decodeTo(Boolean, /*#__PURE__*/Transformation.transform({
@@ -7608,7 +7608,7 @@ export function toFormatter(schema, options) {
  * Use when the default structural equivalence derived by {@link toEquivalence}
  * is not appropriate for a type.
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export function overrideToEquivalence(toEquivalence) {
@@ -7632,7 +7632,7 @@ export function overrideToEquivalence(toEquivalence) {
  * console.log(eq({ id: 1, name: "Alice" }, { id: 2, name: "Alice" })) // false
  * ```
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export function toEquivalence(schema) {
@@ -7661,7 +7661,7 @@ export function toRepresentation(schema) {
  * properties and synthesized check descriptions; it does not change the draft
  * target.
  *
- * @category JsonSchema
+ * @category converting
  * @since 4.0.0
  */
 export function toJsonSchemaDocument(schema, options) {
@@ -8059,7 +8059,7 @@ export function overrideToCodecIso(to, transformation) {
  * {@link toCodecJson}), computes RFC 6902 JSON Patch operations between old
  * and new values, and can apply patches back to the typed value.
  *
- * @category JsonPatch
+ * @category converting
  * @since 4.0.0
  */
 export function toDifferJsonPatch(schema) {
@@ -8102,7 +8102,7 @@ export function Tree(node) {
  * console.log(result._tag) // "Some"
  * ```
  *
- * @category JSON
+ * @category schemas
  * @since 4.0.0
  */
 export const Json = /*#__PURE__*/make(AST.Json);
@@ -8110,7 +8110,7 @@ export const Json = /*#__PURE__*/make(AST.Json);
  * Schema that accepts any mutable JSON-compatible value. See {@link Json} for
  * the immutable variant.
  *
- * @category JSON
+ * @category schemas
  * @since 4.0.0
  */
 export const MutableJson = /*#__PURE__*/make(AST.MutableJson);