effect 4.0.0-beta.82 → 4.0.0-beta.84

package/dist/SchemaGetter.d.ts

@@ -74,7 +74,7 @@ export declare class Getter<out T, in E, R = never> extends Pipeable.Class {
  * The getter is pure and always returns `Option.some(t)` regardless of whether
  * the input is `Some` or `None`.
  *
- * **Example** (Constant getter)
+ * **Example** (Returning a constant getter)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -103,7 +103,7 @@ export declare function succeed<const T, E>(t: T): Getter<T, E>;
  * - Always fails with the `Issue` returned by `f`.
  * - The failure function receives the original `Option<E>` input for error context.
  *
- * **Example** (Always-failing getter)
+ * **Example** (Defining an always-failing getter)
  *
  * ```ts
  * import { Option, SchemaGetter, SchemaIssue } from "effect"
@@ -165,7 +165,7 @@ export declare function forbidden<T, E>(message: (oe: Option.Option<E>) => strin
  * - The default overload requires `T === E`. Pass `{ strict: false }` to opt
  *   out of the type constraint.
  *
- * **Example** (Identity transformation)
+ * **Example** (Passing through identity transformations)
  *
  * ```ts
  * import { Schema, SchemaGetter } from "effect"
@@ -202,7 +202,7 @@ export declare function passthrough<T>(): Getter<T, T>;
  *
  * - Same singleton as {@link passthrough} — no allocation, optimized in composition.
  *
- * **Example** (Supertype passthrough)
+ * **Example** (Passing through supertypes)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -230,7 +230,7 @@ export declare function passthroughSupertype<T extends E, E>(): Getter<T, E>;
  *
  * - Same singleton as {@link passthrough} — no allocation, optimized in composition.
  *
- * **Example** (Subtype passthrough)
+ * **Example** (Passing through subtypes)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -261,7 +261,7 @@ export declare function passthroughSubtype<T, E extends T>(): Getter<T, E>;
  * - When input is `Some`, passes it through unchanged.
  * - `f` receives the parse options and may return `None` to keep the value absent.
  *
- * **Example** (Default timestamp for missing field)
+ * **Example** (Providing a default timestamp for a missing field)
  *
  * ```ts
  * import { Effect, Option, SchemaGetter } from "effect"
@@ -293,7 +293,7 @@ export declare function onNone<T, E extends T = T, R = never>(f: (options: Schem
  * - When input is `Some`, passes it through unchanged.
  * - Optional `annotations` customize the error message for the missing key.
  *
- * **Example** (Required struct field)
+ * **Example** (Defining a required struct field)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -323,7 +323,7 @@ export declare function required<T, E extends T = T>(annotations?: Schema.Annota
  * - When input is `Some(e)`, calls `f(e, options)` to produce the result.
  * - `f` may return `None` to omit the value, or fail with an `Issue`.
  *
- * **Example** (Transform only present values)
+ * **Example** (Transforming only present values)
  *
  * ```ts
  * import { Effect, Option, SchemaGetter } from "effect"
@@ -361,7 +361,7 @@ export declare function onSome<T, E, R = never>(f: (e: E, options: SchemaAST.Par
  *     message string or a full {@link SchemaIssue.Issue}).
  * - Does not transform the value — input and output types are the same.
  *
- * **Example** (Effectful validation)
+ * **Example** (Validating effectfully)
  *
  * ```ts
  * import { Effect, SchemaGetter } from "effect"
@@ -394,7 +394,7 @@ export declare function checkEffect<T, R = never>(f: (input: T, options: SchemaA
  * - Skips `None` inputs — only called when a value is present.
  * - Never fails.
  *
- * **Example** (String to number transformation pair)
+ * **Example** (Transforming strings to numbers)
  *
  * ```ts
  * import { Schema, SchemaGetter } from "effect"
@@ -464,7 +464,7 @@ export declare function transformOrFail<T, E, R = never>(f: (e: E, options: Sche
  * must return `Option<T>`, so it can turn a present value into absent or an
  * absent value into present.
  *
- * **Example** (Filter out empty strings)
+ * **Example** (Filtering out empty strings)
  *
  * ```ts
  * import { Option, SchemaGetter } from "effect"
@@ -494,7 +494,7 @@ export declare function transformOptional<T, E>(f: (oe: Option.Option<E>) => Opt
  * - Always returns `Option.None` regardless of input.
  * - Never fails.
  *
- * **Example** (Omit a field during encoding)
+ * **Example** (Omitting a field during encoding)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -523,7 +523,7 @@ export declare function omit<T>(): Getter<never, T>;
  * - If the input is `Some(value)` where value is not `undefined`, passes it through.
  * - `defaultValue` is an `Effect` that will be executed each time a default is needed.
  *
- * **Example** (Default value for optional field)
+ * **Example** (Providing a default value for an optional field)
  *
  * ```ts
  * import { Effect, SchemaGetter } from "effect"
@@ -551,7 +551,7 @@ export declare function withDefault<T, R = never>(defaultValue: Effect.Effect<T,
  *
  * The getter is pure, never fails, and delegates to `globalThis.String`.
  *
- * **Example** (Coerce to string)
+ * **Example** (Coercing to a string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -579,7 +579,7 @@ export declare function String<E>(): Getter<string, E>;
  * The getter is pure, never fails, and delegates to `globalThis.Number`. It may
  * produce `NaN` for non-numeric inputs.
  *
- * **Example** (Coerce to number)
+ * **Example** (Coercing to a number)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -606,7 +606,7 @@ export declare function Number<E>(): Getter<number, E>;
  *
  * The getter is pure, never fails, and delegates to `globalThis.Boolean`.
  *
- * **Example** (Coerce to boolean)
+ * **Example** (Coercing to a boolean)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -632,7 +632,7 @@ export declare function Boolean<E>(): Getter<boolean, E>;
  * - Delegates to `globalThis.BigInt`.
  * - Throws at runtime if the input cannot be converted (e.g. non-numeric string).
  *
- * **Example** (Coerce to bigint)
+ * **Example** (Coercing to a bigint)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -658,7 +658,7 @@ export declare function BigInt<E extends string | number | bigint | boolean>():
  * - Delegates to `new globalThis.Date(input)`.
  * - Does not validate the result — may produce an invalid Date.
  *
- * **Example** (Coerce to Date)
+ * **Example** (Coercing to a Date)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -680,7 +680,7 @@ export declare function Date<E extends string | number | Date>(): Getter<Date, E
  *
  * - Pure, delegates to `String.trim`.
  *
- * **Example** (Trim whitespace)
+ * **Example** (Trimming whitespace)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -699,7 +699,7 @@ export declare function trim<E extends string>(): Getter<string, E>;
  *
  * - Pure, delegates to `String.capitalize`.
  *
- * **Example** (Capitalize string)
+ * **Example** (Capitalizing a string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -718,7 +718,7 @@ export declare function capitalize<E extends string>(): Getter<string, E>;
  *
  * - Pure, delegates to `String.uncapitalize`.
  *
- * **Example** (Uncapitalize string)
+ * **Example** (Uncapitalizing a string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -737,7 +737,7 @@ export declare function uncapitalize<E extends string>(): Getter<string, E>;
  *
  * - Pure, delegates to `String.snakeToCamel`.
  *
- * **Example** (Snake to camel)
+ * **Example** (Converting snake case to camel case)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -758,7 +758,7 @@ export declare function snakeToCamel<E extends string>(): Getter<string, E>;
  *
  * - Pure, delegates to `String.camelToSnake`.
  *
- * **Example** (Camel to snake)
+ * **Example** (Converting camel case to snake case)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -779,7 +779,7 @@ export declare function camelToSnake<E extends string>(): Getter<string, E>;
  *
  * - Pure, delegates to `String.toLowerCase`.
  *
- * **Example** (To lowercase)
+ * **Example** (Converting to lowercase)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -800,7 +800,7 @@ export declare function toLowerCase<E extends string>(): Getter<string, E>;
  *
  * - Pure, delegates to `String.toUpperCase`.
  *
- * **Example** (To uppercase)
+ * **Example** (Converting to uppercase)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -832,7 +832,7 @@ type ParseJsonOptions = {
  * - With `reviver`: returns `unknown` (reviver may produce arbitrary values).
  * - On parse failure, fails with `SchemaIssue.InvalidValue` containing the error message.
  *
- * **Example** (Parse JSON)
+ * **Example** (Parsing JSON)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -871,7 +871,7 @@ type StringifyJsonOptions = {
  *   functions, symbols, or a replacer that removes the root value, that
  *   `undefined` result is returned rather than converted into an `Issue`.
  *
- * **Example** (Stringify JSON)
+ * **Example** (Stringifying JSON)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -900,7 +900,7 @@ export declare function stringifyJson(options?: StringifyJsonOptions): Getter<st
  * (default `,`) and then each pair by `keyValueSeparator` (default `=`). Pairs
  * missing a key or value are silently skipped.
  *
- * **Example** (Parse key-value string)
+ * **Example** (Parsing a key-value string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -933,7 +933,7 @@ export declare function splitKeyValue<E extends string>(options?: {
  * (default `,`) and joins each key and value with `keyValueSeparator` (default
  * `=`).
  *
- * **Example** (Join key-value record)
+ * **Example** (Joining key-value records)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -964,7 +964,7 @@ export declare function joinKeyValue<E extends Record<PropertyKey, string>>(opti
  * The getter is pure and never fails. It splits by `separator` (default `,`).
  * An empty string produces an empty array, not `[""]`.
  *
- * **Example** (Split comma-separated string)
+ * **Example** (Splitting a comma-separated string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -989,7 +989,7 @@ export declare function split<E extends string>(options?: {
  *
  * The getter is pure and never fails.
  *
- * **Example** (Encode to Base64)
+ * **Example** (Encoding to Base64)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1012,7 +1012,7 @@ export declare function encodeBase64<E extends Uint8Array | string>(): Getter<st
  *
  * The getter is pure and never fails.
  *
- * **Example** (Encode to Base64Url)
+ * **Example** (Encoding to Base64Url)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1035,7 +1035,7 @@ export declare function encodeBase64Url<E extends Uint8Array | string>(): Getter
  *
  * The getter is pure and never fails.
  *
- * **Example** (Encode to hex)
+ * **Example** (Encoding to hex)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1057,7 +1057,7 @@ export declare function encodeHex<E extends Uint8Array | string>(): Getter<strin
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input is not valid Base64.
  *
- * **Example** (Decode Base64 to bytes)
+ * **Example** (Decoding Base64 to bytes)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1080,7 +1080,7 @@ export declare function decodeBase64<E extends string>(): Getter<Uint8Array, E>;
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input is not valid Base64.
  *
- * **Example** (Decode Base64 to string)
+ * **Example** (Decoding Base64 to string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1103,7 +1103,7 @@ export declare function decodeBase64String<E extends string>(): Getter<string, E
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input is not valid Base64Url.
  *
- * **Example** (Decode Base64Url to bytes)
+ * **Example** (Decoding Base64Url to bytes)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1126,7 +1126,7 @@ export declare function decodeBase64Url<E extends string>(): Getter<Uint8Array,
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input is not valid Base64Url.
  *
- * **Example** (Decode Base64Url to string)
+ * **Example** (Decoding Base64Url to string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1149,7 +1149,7 @@ export declare function decodeBase64UrlString<E extends string>(): Getter<string
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input is not valid hex.
  *
- * **Example** (Decode hex to bytes)
+ * **Example** (Decoding hex to bytes)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1172,7 +1172,7 @@ export declare function decodeHex<E extends string>(): Getter<Uint8Array, E>;
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input is not valid hex.
  *
- * **Example** (Decode hex to string)
+ * **Example** (Decoding hex to string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1197,7 +1197,7 @@ export declare function decodeHexString<E extends string>(): Getter<string, E>;
  * - May throw a `URIError` for malformed surrogate pairs; this exception is not
  *   converted into an `Issue`.
  *
- * **Example** (Encode a URI component)
+ * **Example** (Encoding a URI component)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1218,7 +1218,7 @@ export declare function encodeUriComponent<E extends string>(): Getter<string, E
  *
  * - Fails with `SchemaIssue.InvalidValue` if the input contains malformed percent-encoding sequences.
  *
- * **Example** (Decode a URI component)
+ * **Example** (Decoding a URI component)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1250,7 +1250,7 @@ export declare function decodeUriComponent<E extends string>(): Getter<string, E
  * - Fails with `SchemaIssue.InvalidValue` if the input cannot be parsed as a valid
  *   `DateTime`.
  *
- * **Example** (Parse DateTime)
+ * **Example** (Parsing DateTime)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1279,7 +1279,7 @@ export declare function dateTimeUtcFromInput<E extends DateTime.DateTime.Input>(
  * `user[name]` and `items[0]` to build nested objects or arrays, and each leaf
  * value is a `string` or `Blob`.
  *
- * **Example** (Decode FormData)
+ * **Example** (Decoding FormData)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1310,7 +1310,7 @@ export declare function decodeFormData(): Getter<Schema.TreeRecord<string | Blob
  * bracket-path keys such as `user[name]` and `items[0]`. Non-object inputs
  * produce an empty `FormData`.
  *
- * **Example** (Encode to FormData)
+ * **Example** (Encoding to FormData)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1341,7 +1341,7 @@ export declare function encodeFormData(): Getter<FormData, unknown>;
  * `user[name]` and `items[0]` to build nested objects or arrays, and each leaf
  * value is a `string`.
  *
- * **Example** (Decode URLSearchParams)
+ * **Example** (Decoding URLSearchParams)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1371,7 +1371,7 @@ export declare function decodeURLSearchParams(): Getter<Schema.TreeRecord<string
  * The getter is pure and never fails. It flattens nested objects or arrays into
  * bracket-path keys. Non-object inputs produce an empty `URLSearchParams`.
  *
- * **Example** (Encode to URLSearchParams)
+ * **Example** (Encoding to URLSearchParams)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1411,7 +1411,7 @@ export declare function encodeURLSearchParams(): Getter<URLSearchParams, unknown
  *   - `""` → real empty key
  * - Duplicate keys for the same path are merged into arrays.
  *
- * **Example** (Build tree from bracket paths)
+ * **Example** (Building a tree from bracket paths)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1452,7 +1452,7 @@ export declare function makeTreeRecord<A>(bracketPathEntries: ReadonlyArray<read
  *   (e.g. `tags=a&tags=b`). Otherwise uses indexed bracket paths (e.g. `items[0]`, `items[1]`).
  * - Non-leaf values that aren't objects or arrays are silently skipped.
  *
- * **Example** (Flatten object to bracket paths)
+ * **Example** (Flattening an object to bracket paths)
  *
  * ```ts
  * import { Predicate, SchemaGetter } from "effect"