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

package/dist/SchemaGetter.js

@@ -89,7 +89,7 @@ export class Getter 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"
@@ -120,7 +120,7 @@ export function succeed(t) {
  * - 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"
@@ -201,7 +201,7 @@ export function passthroughSubtype() {
  * - 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"
@@ -235,7 +235,7 @@ export function onNone(f) {
  * - 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"
@@ -267,7 +267,7 @@ export function required(annotations) {
  * - 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"
@@ -307,7 +307,7 @@ export function onSome(f) {
  *     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"
@@ -347,7 +347,7 @@ export function checkEffect(f) {
  * - 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"
@@ -421,7 +421,7 @@ export function transformOrFail(f) {
  * 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"
@@ -453,7 +453,7 @@ export function transformOptional(f) {
  * - 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"
@@ -484,7 +484,7 @@ export function omit() {
  * - 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"
@@ -517,7 +517,7 @@ export function withDefault(defaultValue) {
  *
  * 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"
@@ -547,7 +547,7 @@ export function String() {
  * 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"
@@ -576,7 +576,7 @@ export function Number() {
  *
  * 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"
@@ -604,7 +604,7 @@ export function Boolean() {
  * - 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"
@@ -632,7 +632,7 @@ export function BigInt() {
  * - 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"
@@ -656,7 +656,7 @@ export function Date() {
  *
  * - Pure, delegates to `String.trim`.
  *
- * **Example** (Trim whitespace)
+ * **Example** (Trimming whitespace)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -677,7 +677,7 @@ export function trim() {
  *
  * - Pure, delegates to `String.capitalize`.
  *
- * **Example** (Capitalize string)
+ * **Example** (Capitalizing a string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -698,7 +698,7 @@ export function capitalize() {
  *
  * - Pure, delegates to `String.uncapitalize`.
  *
- * **Example** (Uncapitalize string)
+ * **Example** (Uncapitalizing a string)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -719,7 +719,7 @@ export function uncapitalize() {
  *
  * - Pure, delegates to `String.snakeToCamel`.
  *
- * **Example** (Snake to camel)
+ * **Example** (Converting snake case to camel case)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -742,7 +742,7 @@ export function snakeToCamel() {
  *
  * - Pure, delegates to `String.camelToSnake`.
  *
- * **Example** (Camel to snake)
+ * **Example** (Converting camel case to snake case)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -765,7 +765,7 @@ export function camelToSnake() {
  *
  * - Pure, delegates to `String.toLowerCase`.
  *
- * **Example** (To lowercase)
+ * **Example** (Converting to lowercase)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -788,7 +788,7 @@ export function toLowerCase() {
  *
  * - Pure, delegates to `String.toUpperCase`.
  *
- * **Example** (To uppercase)
+ * **Example** (Converting to uppercase)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -831,7 +831,7 @@ export function parseJson(options) {
  *   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"
@@ -867,7 +867,7 @@ export function stringifyJson(options) {
  * (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"
@@ -907,7 +907,7 @@ export function splitKeyValue(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"
@@ -939,7 +939,7 @@ export function joinKeyValue(options) {
  * 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"
@@ -965,7 +965,7 @@ export function split(options) {
  *
  * The getter is pure and never fails.
  *
- * **Example** (Encode to Base64)
+ * **Example** (Encoding to Base64)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -990,7 +990,7 @@ export function encodeBase64() {
  *
  * The getter is pure and never fails.
  *
- * **Example** (Encode to Base64Url)
+ * **Example** (Encoding to Base64Url)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1015,7 +1015,7 @@ export function encodeBase64Url() {
  *
  * The getter is pure and never fails.
  *
- * **Example** (Encode to hex)
+ * **Example** (Encoding to hex)
  *
  * ```ts
  * import { SchemaGetter } from "effect"
@@ -1039,7 +1039,7 @@ export function encodeHex() {
  *
  * - 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"
@@ -1066,7 +1066,7 @@ export function decodeBase64() {
  *
  * - 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"
@@ -1096,7 +1096,7 @@ export function decodeBase64String() {
  *
  * - 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 function decodeBase64Url() {
  *
  * - 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"
@@ -1156,7 +1156,7 @@ export function decodeBase64UrlString() {
  *
  * - 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"
@@ -1186,7 +1186,7 @@ export function decodeHex() {
  *
  * - 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"
@@ -1218,7 +1218,7 @@ export function decodeHexString() {
  * - 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"
@@ -1241,7 +1241,7 @@ export function encodeUriComponent() {
  *
  * - 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"
@@ -1283,7 +1283,7 @@ export function decodeUriComponent() {
  * - 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"
@@ -1321,7 +1321,7 @@ export function dateTimeUtcFromInput() {
  * `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"
@@ -1355,7 +1355,7 @@ const collectFormDataEntries = /*#__PURE__*/collectBracketPathEntries(value => t
  * 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"
@@ -1397,7 +1397,7 @@ export function encodeFormData() {
  * `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"
@@ -1430,7 +1430,7 @@ const collectURLSearchParamsEntries = /*#__PURE__*/collectBracketPathEntries(Pre
  * 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"
@@ -1489,7 +1489,7 @@ function bracketPathToTokens(bracketPath) {
  *   - `""` → 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"
@@ -1573,7 +1573,7 @@ export function makeTreeRecord(bracketPathEntries) {
  *   (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"

package/dist/SchemaIssue.d.ts

@@ -384,7 +384,7 @@ export declare class Composite extends Base {
  *   `Option.none()` when no value was provided.
  * - The default formatter renders this as `"Expected <type>, got <actual>"`.
  *
- * **Example** (Formatted output)
+ * **Example** (Formatting output)
  *
  * ```ts
  * import { Schema } from "effect"
@@ -441,7 +441,7 @@ export declare class InvalidType extends Base {
  * - The default formatter renders this as `"Invalid data <actual>"` unless a
  *   custom `message` annotation is provided.
  *
- * **Example** (Custom filter returning InvalidValue)
+ * **Example** (Returning InvalidValue from a custom filter)
  *
  * ```ts
  * import { Option, SchemaIssue } from "effect"
@@ -714,7 +714,7 @@ export type LeafHook = (issue: Leaf) => string;
  *   - `Forbidden` → `"Forbidden operation"`
  *   - `OneOf` → `"Expected exactly one member to match the input <actual>"`
  *
- * **Example** (Using defaultLeafHook with Standard Schema formatter)
+ * **Example** (Formatting Standard Schema issues with defaultLeafHook)
  *
  * ```ts
  * import { SchemaIssue } from "effect"

package/dist/SchemaIssue.js

@@ -359,7 +359,7 @@ export class Composite extends Base {
  *   `Option.none()` when no value was provided.
  * - The default formatter renders this as `"Expected <type>, got <actual>"`.
  *
- * **Example** (Formatted output)
+ * **Example** (Formatting output)
  *
  * ```ts
  * import { Schema } from "effect"
@@ -420,7 +420,7 @@ export class InvalidType extends Base {
  * - The default formatter renders this as `"Invalid data <actual>"` unless a
  *   custom `message` annotation is provided.
  *
- * **Example** (Custom filter returning InvalidValue)
+ * **Example** (Returning InvalidValue from a custom filter)
  *
  * ```ts
  * import { Option, SchemaIssue } from "effect"
@@ -737,7 +737,7 @@ export function make(input, ast, out) {
  *   - `Forbidden` → `"Forbidden operation"`
  *   - `OneOf` → `"Expected exactly one member to match the input <actual>"`
  *
- * **Example** (Using defaultLeafHook with Standard Schema formatter)
+ * **Example** (Formatting Standard Schema issues with defaultLeafHook)
  *
  * ```ts
  * import { SchemaIssue } from "effect"