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

package/dist/Metric.d.ts

@@ -1554,7 +1554,7 @@ export declare namespace Metric {
 /**
  * Service key for the current metric attributes context.
  *
- * **Example** (Using the current attributes key)
+ * **Example** (Accessing the current metric attributes key)
  *
  * ```ts
  * import { Data, Effect, Metric } from "effect"
@@ -3551,7 +3551,7 @@ export declare const exponentialBoundaries: (options: {
 /**
  * Service key for the fiber runtime metrics service.
  *
- * **Example** (Using the fiber runtime metrics key)
+ * **Example** (Accessing the fiber runtime metrics key)
  *
  * ```ts
  * import { Data, Effect, Layer, Metric } from "effect"
@@ -3691,7 +3691,7 @@ export declare const FiberRuntimeMetrics: Context.Reference<FiberRuntimeMetricsS
 /**
  * Default implementation of the fiber runtime metrics service.
  *
- * **Example** (Using the default fiber metrics implementation)
+ * **Example** (Accessing the default fiber metrics implementation)
  *
  * ```ts
  * import { Data, Effect, Layer, Metric } from "effect"

package/dist/Metric.js

@@ -24,7 +24,7 @@ import * as _String from "./String.js";
 /**
  * Service key for the current metric attributes context.
  *
- * **Example** (Using the current attributes key)
+ * **Example** (Accessing the current metric attributes key)
  *
  * ```ts
  * import { Data, Effect, Metric } from "effect"
@@ -1675,7 +1675,7 @@ const fiberFailures = /*#__PURE__*/counter("child_fiber_failures", {
 /**
  * Service key for the fiber runtime metrics service.
  *
- * **Example** (Using the fiber runtime metrics key)
+ * **Example** (Accessing the fiber runtime metrics key)
  *
  * ```ts
  * import { Data, Effect, Layer, Metric } from "effect"
@@ -1774,7 +1774,7 @@ export const FiberRuntimeMetrics = /*#__PURE__*/Context.Reference(InternalMetric
 /**
  * Default implementation of the fiber runtime metrics service.
  *
- * **Example** (Using the default fiber metrics implementation)
+ * **Example** (Accessing the default fiber metrics implementation)
  *
  * ```ts
  * import { Data, Effect, Layer, Metric } from "effect"

package/dist/Optic.d.ts

@@ -32,7 +32,7 @@ import type { IsUnion } from "./Types.ts";
  * - `get(set(a)) === a` and `set(get(s))` equals `s` (round-trip laws).
  * - Extends both {@link Lens} and {@link Prism}.
  *
- * **Example** (Celsius ↔ Fahrenheit)
+ * **Example** (Converting between Celsius and Fahrenheit)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -70,7 +70,7 @@ export interface Iso<in out S, in out A> extends Lens<S, A>, Prism<S, A> {
  *
  * The returned optic can be composed with any other optic.
  *
- * **Example** (wrapping/unwrapping a branded type)
+ * **Example** (Wrapping and unwrapping a branded type)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -111,7 +111,7 @@ export declare function makeIso<S, A>(get: (s: S) => A, set: (a: A) => S): Iso<S
  * - Composing a Lens with a {@link Prism} or {@link Optional} produces an
  *   {@link Optional}.
  *
- * **Example** (focusing on a struct field)
+ * **Example** (Focusing on a struct field)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -147,7 +147,7 @@ export interface Lens<in out S, in out A> extends Optional<S, A> {
  * - `replace(a, s)` should return a structurally new `S` with `a` in place
  *   of the old focus.
  *
- * **Example** (lens into the first element of a pair)
+ * **Example** (Focusing on the first element of a pair)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -190,7 +190,7 @@ export declare function makeLens<S, A>(get: (s: S) => A, replace: (a: A, s: S) =
  * - Composing two Prisms produces a Prism; composing a Prism with a
  *   {@link Lens} produces an {@link Optional}.
  *
- * **Example** (narrowing a tagged union)
+ * **Example** (Narrowing a tagged union)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -230,7 +230,7 @@ export interface Prism<in out S, in out A> extends Optional<S, A> {
  *
  * - `getResult` should return `Result.fail(message)` on mismatch.
  *
- * **Example** (parsing a string to a number)
+ * **Example** (Parsing a string to a number)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -272,7 +272,7 @@ export declare function makePrism<S, A>(getResult: (s: S) => Result.Result<A, st
  *   any check fails.
  * - `set` is identity — the value passes through unchanged.
  *
- * **Example** (positive integer prism)
+ * **Example** (Creating a positive integer prism)
  *
  * ```ts
  * import { Optic, Result, Schema } from "effect"
@@ -359,7 +359,7 @@ type ForbidUnion<A, Message extends string> = IsUnion<A> extends true ? [Message
  * - `modify(f)` returns the original `s` on failure (never throws).
  * - All operations are pure; inputs are never mutated.
  *
- * **Example** (record key that may be absent)
+ * **Example** (Focusing on an optional record key)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -407,7 +407,7 @@ export interface Optional<in out S, in out A> {
      * Composes this optic with another. The result type is the weakest of
      * the two: Iso + Iso = Iso, Lens + Prism = Optional, etc.
      *
-     * **Example** (composing a lens with a prism)
+     * **Example** (Composing a lens with a prism)
      *
      * ```ts
      * import { Optic, Option } from "effect"
@@ -428,7 +428,7 @@ export interface Optional<in out S, in out A> {
      * Returns a function `(s: S) => S` that applies `f` to the focused value.
      * If the optic cannot focus, the original `s` is returned unchanged.
      *
-     * **Example** (incrementing a nested field)
+     * **Example** (Incrementing a nested field)
      *
      * ```ts
      * import { Optic } from "effect"
@@ -451,7 +451,7 @@ export interface Optional<in out S, in out A> {
      * - On an {@link Optional}, returns an Optional.
      * - Does **not** work on union types (compile error).
      *
-     * **Example** (drilling into nested structs)
+     * **Example** (Drilling into nested structs)
      *
      * ```ts
      * import { Optic } from "effect"
@@ -474,7 +474,7 @@ export interface Optional<in out S, in out A> {
      * - The focus type becomes `A[Key] | undefined`.
      * - Does **not** work on union types (compile error).
      *
-     * **Example** (deleting an optional key)
+     * **Example** (Deleting an optional key)
      *
      * ```ts
      * import { Optic } from "effect"
@@ -500,7 +500,7 @@ export interface Optional<in out S, in out A> {
      * - On a {@link Prism}, returns a Prism.
      * - On an {@link Optional}, returns an Optional.
      *
-     * **Example** (only focus positive numbers)
+     * **Example** (Focusing only on positive numbers)
      *
      * ```ts
      * import { Optic, Result, Schema } from "effect"
@@ -527,7 +527,7 @@ export interface Optional<in out S, in out A> {
      * - On an {@link Optional}, returns an Optional.
      * - Pass optional `annotations` to customize the error message.
      *
-     * **Example** (narrowing a union)
+     * **Example** (Narrowing a union)
      *
      * ```ts
      * import { Optic, Result } from "effect"
@@ -558,7 +558,7 @@ export interface Optional<in out S, in out A> {
      * - On an {@link Optional}, returns an Optional.
      * - Shorthand for `.refine(s => s._tag === tag)`.
      *
-     * **Example** (focusing a tagged variant)
+     * **Example** (Focusing a tagged variant)
      *
      * ```ts
      * import { Optic, Result } from "effect"
@@ -600,7 +600,7 @@ export interface Optional<in out S, in out A> {
      * - Always returns an {@link Optional}.
      * - Does **not** work on union types (compile error).
      *
-     * **Example** (safe record access)
+     * **Example** (Accessing records safely)
      *
      * ```ts
      * import { Optic, Result } from "effect"
@@ -627,7 +627,7 @@ export interface Optional<in out S, in out A> {
      * - On an {@link Optional}, returns an Optional.
      * - Does **not** work on union types (compile error).
      *
-     * **Example** (picking keys)
+     * **Example** (Picking keys)
      *
      * ```ts
      * import { Optic } from "effect"
@@ -653,7 +653,7 @@ export interface Optional<in out S, in out A> {
      * - On an {@link Optional}, returns an Optional.
      * - Does **not** work on union types (compile error).
      *
-     * **Example** (omitting keys)
+     * **Example** (Omitting keys)
      *
      * ```ts
      * import { Optic } from "effect"
@@ -676,7 +676,7 @@ export interface Optional<in out S, in out A> {
      * Filters out `undefined` from the focus, producing a {@link Prism}.
      * `getResult` fails when the focus is `undefined`.
      *
-     * **Example** (filtering undefined)
+     * **Example** (Filtering undefined values)
      *
      * ```ts
      * import { Optic, Result } from "effect"
@@ -709,7 +709,7 @@ export interface Optional<in out S, in out A> {
      *   `getResult` and writes them back in order. Fails with a
      *   length-mismatch error if counts differ.
      *
-     * **Example** (incrementing liked posts)
+     * **Example** (Incrementing liked posts)
      *
      * ```ts
      * import { Optic, Schema } from "effect"
@@ -747,7 +747,7 @@ export interface Optional<in out S, in out A> {
      * Unlike `.modify()`, which operates on the whole array, `modifyAll`
      * maps `f` over each individual element.
      *
-     * **Example** (doubling all focused values)
+     * **Example** (Doubling all focused values)
      *
      * ```ts
      * import { Optic, Schema } from "effect"
@@ -783,7 +783,7 @@ export interface Optional<in out S, in out A> {
  * - `set` should return `Result.fail(message)` when the update cannot be
  *   applied.
  *
- * **Example** (safe record key access)
+ * **Example** (Accessing record keys safely)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -829,7 +829,7 @@ export declare function makeOptional<S, A>(getResult: (s: S) => Result.Result<A,
  * - Use `.modifyAll(f)` to map a function over every focused element.
  * - Use {@link getAll} to extract all focused elements as a plain array.
  *
- * **Example** (traversing array elements with a filter)
+ * **Example** (Traversing array elements with a filter)
  *
  * ```ts
  * import { Optic, Schema } from "effect"
@@ -868,7 +868,7 @@ export interface Traversal<in out S, in out A> extends Optional<S, ReadonlyArray
  * - Returns an empty array when the traversal cannot focus.
  * - Always returns a fresh array (safe to mutate).
  *
- * **Example** (collecting positive numbers)
+ * **Example** (Collecting positive numbers)
  *
  * ```ts
  * import { Optic, Schema } from "effect"
@@ -907,7 +907,7 @@ export declare function getAll<S, A>(traversal: Traversal<S, A>): (s: S) => Arra
  * - `set(a)` returns `a`.
  * - Singleton — every call returns the same instance.
  *
- * **Example** (starting an optic chain)
+ * **Example** (Starting an optic chain)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -941,7 +941,7 @@ export declare function id<S>(): Iso<S, S>;
  * - `set` uses `Object.fromEntries`.
  * - Round-trip is lossless for `Record<string, A>`.
  *
- * **Example** (traversing record values)
+ * **Example** (Traversing record values)
  *
  * ```ts
  * import { Optic, Schema } from "effect"
@@ -975,7 +975,7 @@ export declare function entries<A>(): Iso<Record<string, A>, ReadonlyArray<reado
  * - `getResult` fails with an error message when the option is `None`.
  * - `set(a)` wraps `a` in `Option.some(a)`.
  *
- * **Example** (accessing Some value)
+ * **Example** (Accessing Some value)
  *
  * ```ts
  * import { Optic, Option, Result } from "effect"
@@ -1012,7 +1012,7 @@ export declare function some<A>(): Prism<Option.Option<A>, A>;
  * - `getResult` fails when the option is `Some`.
  * - `set(undefined)` produces `Option.none()`.
  *
- * **Example** (matching None)
+ * **Example** (Matching None)
  *
  * ```ts
  * import { Optic, Option, Result } from "effect"
@@ -1046,7 +1046,7 @@ export declare function none<A>(): Prism<Option.Option<A>, undefined>;
  * - `getResult` fails when the result is a `Failure`.
  * - `set(a)` produces `Result.succeed(a)`.
  *
- * **Example** (accessing success)
+ * **Example** (Accessing success)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -1080,7 +1080,7 @@ export declare function success<A, E>(): Prism<Result.Result<A, E>, A>;
  * - `getResult` fails when the result is a `Success`.
  * - `set(e)` produces `Result.fail(e)`.
  *
- * **Example** (accessing failure)
+ * **Example** (Accessing failure)
  *
  * ```ts
  * import { Optic, Result } from "effect"

package/dist/Optic.js

@@ -30,7 +30,7 @@ import * as Struct from "./Struct.js";
  *
  * The returned optic can be composed with any other optic.
  *
- * **Example** (wrapping/unwrapping a branded type)
+ * **Example** (Wrapping and unwrapping a branded type)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -70,7 +70,7 @@ export function makeIso(get, set) {
  * - `replace(a, s)` should return a structurally new `S` with `a` in place
  *   of the old focus.
  *
- * **Example** (lens into the first element of a pair)
+ * **Example** (Focusing on the first element of a pair)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -108,7 +108,7 @@ export function makeLens(get, replace) {
  *
  * - `getResult` should return `Result.fail(message)` on mismatch.
  *
- * **Example** (parsing a string to a number)
+ * **Example** (Parsing a string to a number)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -152,7 +152,7 @@ export function makePrism(getResult, set) {
  *   any check fails.
  * - `set` is identity — the value passes through unchanged.
  *
- * **Example** (positive integer prism)
+ * **Example** (Creating a positive integer prism)
  *
  * ```ts
  * import { Optic, Result, Schema } from "effect"
@@ -294,7 +294,7 @@ function compose(a, b) {
  * - `set` should return `Result.fail(message)` when the update cannot be
  *   applied.
  *
- * **Example** (safe record key access)
+ * **Example** (Accessing record keys safely)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -649,7 +649,7 @@ function getCompositionTag(a, b) {
  * - Returns an empty array when the traversal cannot focus.
  * - Always returns a fresh array (safe to mutate).
  *
- * **Example** (collecting positive numbers)
+ * **Example** (Collecting positive numbers)
  *
  * ```ts
  * import { Optic, Schema } from "effect"
@@ -697,7 +697,7 @@ const identityIso = /*#__PURE__*/make(identityNode);
  * - `set(a)` returns `a`.
  * - Singleton — every call returns the same instance.
  *
- * **Example** (starting an optic chain)
+ * **Example** (Starting an optic chain)
  *
  * ```ts
  * import { Optic } from "effect"
@@ -733,7 +733,7 @@ export function id() {
  * - `set` uses `Object.fromEntries`.
  * - Round-trip is lossless for `Record<string, A>`.
  *
- * **Example** (traversing record values)
+ * **Example** (Traversing record values)
  *
  * ```ts
  * import { Optic, Schema } from "effect"
@@ -769,7 +769,7 @@ export function entries() {
  * - `getResult` fails with an error message when the option is `None`.
  * - `set(a)` wraps `a` in `Option.some(a)`.
  *
- * **Example** (accessing Some value)
+ * **Example** (Accessing Some value)
  *
  * ```ts
  * import { Optic, Option, Result } from "effect"
@@ -814,7 +814,7 @@ export function some() {
  * - `getResult` fails when the option is `Some`.
  * - `set(undefined)` produces `Option.none()`.
  *
- * **Example** (matching None)
+ * **Example** (Matching None)
  *
  * ```ts
  * import { Optic, Option, Result } from "effect"
@@ -856,7 +856,7 @@ export function none() {
  * - `getResult` fails when the result is a `Failure`.
  * - `set(a)` produces `Result.succeed(a)`.
  *
- * **Example** (accessing success)
+ * **Example** (Accessing success)
  *
  * ```ts
  * import { Optic, Result } from "effect"
@@ -898,7 +898,7 @@ export function success() {
  * - `getResult` fails when the result is a `Success`.
  * - `set(e)` produces `Result.fail(e)`.
  *
- * **Example** (accessing failure)
+ * **Example** (Accessing failure)
  *
  * ```ts
  * import { Optic, Result } from "effect"

package/dist/Option.d.ts

@@ -1049,7 +1049,7 @@ export declare const firstSomeOf: <T, C extends Iterable<Option<T>> = Iterable<O
  * - `null` or `undefined` → `None`
  * - Any other value → `Some` (typed as `NonNullable<A>`)
  *
- * **Example** (From nullable values)
+ * **Example** (Converting nullable values to an Option)
  *
  * ```ts
  * import { Option } from "effect"
@@ -1086,7 +1086,7 @@ export declare const fromNullishOr: <A>(a: A) => Option<NonNullable<A>>;
  * - `undefined` → `None`
  * - Any other value (including `null`) → `Some`
  *
- * **Example** (From possibly-undefined values)
+ * **Example** (Converting possibly undefined values to an Option)
  *
  * ```ts
  * import { Option } from "effect"
@@ -1122,7 +1122,7 @@ export declare const fromUndefinedOr: <A>(a: A) => Option<Exclude<A, undefined>>
  * - `null` → `None`
  * - Any other value (including `undefined`) → `Some`
  *
- * **Example** (From possibly-null values)
+ * **Example** (Converting possibly null values to an Option)
  *
  * ```ts
  * import { Option } from "effect"
@@ -1625,7 +1625,7 @@ export {
  *
  * Use to return a "success with no meaningful value" from an `Option`-returning function
  *
- * **Example** (Using Option.void)
+ * **Example** (Referencing Option.void)
  *
  * ```ts
  * import { Option } from "effect"
@@ -3769,7 +3769,7 @@ export declare const liftPredicate: {
  * - `Some` where `isEquivalent(value, a)` is `true` → `true`
  * - `Some` where not equivalent, or `None` → `false`
  *
- * **Example** (Custom equivalence check)
+ * **Example** (Checking with custom equivalence)
  *
  * ```ts
  * import { Equivalence, Option } from "effect"
@@ -4346,7 +4346,7 @@ export declare const bind: {
  * Use when you need to start an `Option` do notation pipeline before adding
  * bindings.
  *
- * **Example** (Do notation pipeline)
+ * **Example** (Building Option pipelines with do notation)
  *
  * ```ts
  * import { Option, pipe } from "effect"
@@ -4385,7 +4385,7 @@ export declare const Do: Option<{}>;
  * - The return value is wrapped in `Some`
  * - No `Effect` runtime is needed
  *
- * **Example** (Generator syntax)
+ * **Example** (Sequencing Option computations with generator syntax)
  *
  * ```ts
  * import { Option } from "effect"

package/dist/Option.js

@@ -538,7 +538,7 @@ export const firstSomeOf = collection => {
  * - `null` or `undefined` → `None`
  * - Any other value → `Some` (typed as `NonNullable<A>`)
  *
- * **Example** (From nullable values)
+ * **Example** (Converting nullable values to an Option)
  *
  * ```ts
  * import { Option } from "effect"
@@ -575,7 +575,7 @@ export const fromNullishOr = a => a == null ? none() : some(a);
  * - `undefined` → `None`
  * - Any other value (including `null`) → `Some`
  *
- * **Example** (From possibly-undefined values)
+ * **Example** (Converting possibly undefined values to an Option)
  *
  * ```ts
  * import { Option } from "effect"
@@ -611,7 +611,7 @@ export const fromUndefinedOr = a => a === undefined ? none() : some(a);
  * - `null` → `None`
  * - Any other value (including `undefined`) → `Some`
  *
- * **Example** (From possibly-null values)
+ * **Example** (Converting possibly null values to an Option)
  *
  * ```ts
  * import { Option } from "effect"
@@ -938,7 +938,7 @@ export {
  *
  * Use to return a "success with no meaningful value" from an `Option`-returning function
  *
- * **Example** (Using Option.void)
+ * **Example** (Referencing Option.void)
  *
  * ```ts
  * import { Option } from "effect"
@@ -1787,7 +1787,7 @@ export const liftPredicate = /*#__PURE__*/dual(2, (b, predicate) => predicate(b)
  * - `Some` where `isEquivalent(value, a)` is `true` → `true`
  * - `Some` where not equivalent, or `None` → `false`
  *
- * **Example** (Custom equivalence check)
+ * **Example** (Checking with custom equivalence)
  *
  * ```ts
  * import { Equivalence, Option } from "effect"
@@ -1993,7 +1993,7 @@ export const bind = /*#__PURE__*/doNotation.bind(map, flatMap);
  * Use when you need to start an `Option` do notation pipeline before adding
  * bindings.
  *
- * **Example** (Do notation pipeline)
+ * **Example** (Building Option pipelines with do notation)
  *
  * ```ts
  * import { Option, pipe } from "effect"
@@ -2032,7 +2032,7 @@ export const Do = /*#__PURE__*/some({});
  * - The return value is wrapped in `Some`
  * - No `Effect` runtime is needed
  *
- * **Example** (Generator syntax)
+ * **Example** (Sequencing Option computations with generator syntax)
  *
  * ```ts
  * import { Option } from "effect"