effect 4.0.0-beta.83 → 4.0.0-beta.84

package/dist/Cause.d.ts

@@ -56,7 +56,7 @@ export declare const ReasonTypeId: "~effect/Cause/Reason";
  * `Cause` implements `Equal` — two causes with the same reasons (by value)
  * compare as equal.
  *
- * **Example** (creating and inspecting a cause)
+ * **Example** (Creating and inspecting a cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -76,7 +76,7 @@ export interface Cause<out E> extends Pipeable, Inspectable, Equal {
 /**
  * Checks whether an arbitrary value is a `Cause`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -92,7 +92,7 @@ export declare const isCause: (self: unknown) => self is Cause<unknown>;
 /**
  * Checks whether an arbitrary value is a `Reason` (`Fail`, `Die`, or `Interrupt`).
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -121,7 +121,7 @@ export declare const isReason: (self: unknown) => self is Reason<unknown>;
  * Every reason carries an `annotations` map and an `annotate` method for
  * attaching tracing metadata.
  *
- * **Example** (narrowing a reason)
+ * **Example** (Narrowing a reason)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -144,7 +144,7 @@ export type Reason<E> = Fail<E> | Die | Interrupt;
  * Use as a predicate for `Array.filter` to pick out typed `Fail` reasons when
  * iterating over `cause.reasons`.
  *
- * **Example** (filtering fail reasons)
+ * **Example** (Filtering fail reasons)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -169,7 +169,7 @@ export declare const isFailReason: <E>(self: Reason<E>) => self is Fail<E>;
  * Use as a predicate for `Array.filter` to pick out `Die` (defect) reasons when
  * iterating over `cause.reasons`.
  *
- * **Example** (filtering die reasons)
+ * **Example** (Filtering die reasons)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -194,7 +194,7 @@ export declare const isDieReason: <E>(self: Reason<E>) => self is Die;
  * Use as a predicate for `Array.filter` to pick out `Interrupt` reasons when
  * iterating over `cause.reasons`.
  *
- * **Example** (filtering interrupt reasons)
+ * **Example** (Filtering interrupt reasons)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -220,7 +220,7 @@ export declare namespace Cause {
     /**
      * Extracts the error type `E` from a `Cause<E>`.
      *
-     * **Example** (extracting the error type)
+     * **Example** (Extracting the error type)
      *
      * ```ts
      * import type { Cause } from "effect"
@@ -264,7 +264,7 @@ export declare namespace Reason {
     /**
      * Extracts the error type `E` from a `Reason<E>`.
      *
-     * **Example** (extracting the error type)
+     * **Example** (Extracting the error type)
      *
      * ```ts
      * import type { Cause } from "effect"
@@ -292,7 +292,7 @@ export declare namespace Reason {
  * typed error channel. Use {@link isDieReason} to narrow a `Reason`
  * to this type.
  *
- * **Example** (accessing the defect)
+ * **Example** (Accessing the defect)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -326,7 +326,7 @@ export interface Die extends Cause.ReasonProto<"Die"> {
  * The `error` property carries the typed value `E`. Use {@link isFailReason}
  * to narrow a `Reason` to this type.
  *
- * **Example** (accessing the error)
+ * **Example** (Accessing the error)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -355,7 +355,7 @@ export interface Fail<out E> extends Cause.ReasonProto<"Fail"> {
  *
  * Use {@link isInterruptReason} to narrow a `Reason` to this type.
  *
- * **Example** (accessing the fiber ID)
+ * **Example** (Accessing the fiber ID)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -392,7 +392,7 @@ export interface Interrupt extends Cause.ReasonProto<"Interrupt"> {
  * The `reasons` array is stored as provided. Treat the array as immutable
  * after passing it to this function.
  *
- * **Example** (building a cause from reasons)
+ * **Example** (Building a cause from reasons)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -424,7 +424,7 @@ export declare const fromReasons: <E>(reasons: ReadonlyArray<Reason<E>>) => Caus
  * Represents the absence of failure. Combining any cause with `empty` via
  * {@link combine} returns the original cause unchanged.
  *
- * **Example** (combining with the empty cause)
+ * **Example** (Combining with the empty cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -449,7 +449,7 @@ export declare const empty: Cause<never>;
  *
  * Use to construct a cause from an expected typed error.
  *
- * **Example** (creating a fail cause)
+ * **Example** (Creating a fail cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -474,7 +474,7 @@ export declare const fail: <E>(error: E) => Cause<E>;
  *
  * Use to construct a cause from an untyped defect or unexpected thrown value.
  *
- * **Example** (creating a die cause)
+ * **Example** (Creating a die cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -495,7 +495,7 @@ export declare const die: (defect: unknown) => Cause<never>;
  * Creates a `Cause` containing a single `Interrupt` reason,
  * optionally carrying the interrupting fiber's ID.
  *
- * **Example** (creating an interrupt cause)
+ * **Example** (Creating an interrupt cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -520,7 +520,7 @@ export declare const interrupt: (fiberId?: number | undefined) => Cause<never>;
  * Use when constructing a standalone typed failure reason for
  * {@link fromReasons} or direct comparison.
  *
- * **Example** (creating a Fail reason)
+ * **Example** (Creating a Fail reason)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -545,7 +545,7 @@ export declare const makeFailReason: <E>(error: E) => Fail<E>;
  * Use when constructing a standalone defect reason for {@link fromReasons} or
  * direct comparison.
  *
- * **Example** (creating a Die reason)
+ * **Example** (Creating a Die reason)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -571,7 +571,7 @@ export declare const makeDieReason: (defect: unknown) => Die;
  * Use when constructing a standalone interrupt reason for {@link fromReasons}
  * or direct comparison.
  *
- * **Example** (creating an Interrupt reason)
+ * **Example** (Creating an Interrupt reason)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -596,7 +596,7 @@ export declare const makeInterruptReason: (fiberId?: number | undefined) => Inte
  *
  * Use when you need to detect failures caused only by interruption.
  *
- * **Example** (checking interrupt-only causes)
+ * **Example** (Checking interrupt-only causes)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -628,7 +628,7 @@ export declare const hasInterruptsOnly: <E>(self: Cause<E>) => boolean;
  * containing the mapped failures. If the cause has no `Fail` reasons, the
  * original cause is returned unchanged.
  *
- * **Example** (mapping errors to uppercase)
+ * **Example** (Mapping errors to uppercase)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -661,7 +661,7 @@ export declare const map: {
      * containing the mapped failures. If the cause has no `Fail` reasons, the
      * original cause is returned unchanged.
      *
-     * **Example** (mapping errors to uppercase)
+     * **Example** (Mapping errors to uppercase)
      *
      * ```ts
      * import { Cause } from "effect"
@@ -694,7 +694,7 @@ export declare const map: {
      * containing the mapped failures. If the cause has no `Fail` reasons, the
      * original cause is returned unchanged.
      *
-     * **Example** (mapping errors to uppercase)
+     * **Example** (Mapping errors to uppercase)
      *
      * ```ts
      * import { Cause } from "effect"
@@ -726,7 +726,7 @@ export declare const map: {
  * - If the result is structurally equal to `self`, `self` is returned
  *   (referential shortcut).
  *
- * **Example** (combining two causes)
+ * **Example** (Combining two causes)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -758,7 +758,7 @@ export declare const combine: {
      * - If the result is structurally equal to `self`, `self` is returned
      *   (referential shortcut).
      *
-     * **Example** (combining two causes)
+     * **Example** (Combining two causes)
      *
      * ```ts
      * import { Cause } from "effect"
@@ -790,7 +790,7 @@ export declare const combine: {
      * - If the result is structurally equal to `self`, `self` is returned
      *   (referential shortcut).
      *
-     * **Example** (combining two causes)
+     * **Example** (Combining two causes)
      *
      * ```ts
      * import { Cause } from "effect"
@@ -833,7 +833,7 @@ export declare const combine: {
  * This function is lossy. Use {@link prettyErrors} or iterate `cause.reasons`
  * when you need all failures.
  *
- * **Example** (squashing a cause)
+ * **Example** (Squashing a cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -857,7 +857,7 @@ export declare const squash: <E>(self: Cause<E>) => unknown;
  * Use to check whether a cause includes typed failures before extracting,
  * mapping, or rendering them.
  *
- * **Example** (checking for typed errors)
+ * **Example** (Checking for typed errors)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -884,7 +884,7 @@ export declare const hasFails: <E>(self: Cause<E>) => boolean;
  * Use when you need the full `Fail` reason from a `Cause`, including
  * annotations.
  *
- * **Example** (extracting the first Fail reason)
+ * **Example** (Extracting the first Fail reason)
  *
  * ```ts
  * import { Cause, Result } from "effect"
@@ -913,7 +913,7 @@ export declare const findFail: <E>(self: Cause<E>) => Result.Result<Fail<E>, Cau
  * Use when you need the first typed error value from a `Cause` as a `Result`
  * that preserves the original cause when no match is found.
  *
- * **Example** (extracting the first error value)
+ * **Example** (Extracting the first error value)
  *
  * ```ts
  * import { Cause, Result } from "effect"
@@ -940,7 +940,7 @@ export declare const findError: <E>(self: Cause<E>) => Result.Result<E, Cause<ne
  * Use when you need the first typed error value from a `Cause` as an `Option`,
  * discarding the original cause.
  *
- * **Example** (extracting an error as Option)
+ * **Example** (Extracting an error as Option)
  *
  * ```ts
  * import { Cause, Option } from "effect"
@@ -966,7 +966,7 @@ export declare const findErrorOption: <E>(input: Cause<E>) => Option<E>;
  * Use to check whether a cause includes defects before extracting or rendering
  * them.
  *
- * **Example** (checking for defects)
+ * **Example** (Checking for defects)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -992,7 +992,7 @@ export declare const hasDies: <E>(self: Cause<E>) => boolean;
  * Use when you need the full `Die` reason from a `Cause`, including
  * annotations.
  *
- * **Example** (extracting the first Die reason)
+ * **Example** (Extracting the first Die reason)
  *
  * ```ts
  * import { Cause, Result } from "effect"
@@ -1020,7 +1020,7 @@ export declare const findDie: <E>(self: Cause<E>) => Result.Result<Die, Cause<E>
  * Use when you need the first defect value from a `Cause` as a `Result`,
  * without the full `Die` reason.
  *
- * **Example** (extracting the first defect)
+ * **Example** (Extracting the first defect)
  *
  * ```ts
  * import { Cause, Result } from "effect"
@@ -1041,7 +1041,7 @@ export declare const findDefect: <E>(self: Cause<E>) => Result.Result<unknown, C
 /**
  * Returns `true` if the cause contains at least one `Interrupt` reason.
  *
- * **Example** (checking for interruptions)
+ * **Example** (Checking for interruptions)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1068,7 +1068,7 @@ export declare const hasInterrupts: <E>(self: Cause<E>) => boolean;
  * Use when you need the first `Interrupt` reason from a `Cause`, including the
  * fiber ID and annotations.
  *
- * **Example** (extracting the first interrupt)
+ * **Example** (Extracting the first interrupt)
  *
  * ```ts
  * import { Cause, Result } from "effect"
@@ -1095,7 +1095,7 @@ export declare const findInterrupt: <E>(self: Cause<E>) => Result.Result<Interru
  * Use when you need interrupting fiber IDs as a set, with absence represented
  * as an empty set.
  *
- * **Example** (collecting interruptors)
+ * **Example** (Collecting interruptors)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1130,7 +1130,7 @@ export declare const interruptors: <E>(self: Cause<E>) => ReadonlySet<number>;
  * function succeeds with an empty `Set` when every interrupt reason has an
  * undefined fiber ID.
  *
- * **Example** (extracting interruptors with Result)
+ * **Example** (Extracting interruptors with Result)
  *
  * ```ts
  * import { Cause, Result } from "effect"
@@ -1174,7 +1174,7 @@ export declare const filterInterruptors: <E>(self: Cause<E>) => Result.Result<Se
  *
  * An empty cause returns an empty array.
  *
- * **Example** (converting a cause to errors)
+ * **Example** (Converting a cause to errors)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1221,7 +1221,7 @@ export declare const prettyErrors: <E>(self: Cause<E>) => Array<Error>;
  * Rendering an empty cause produces an empty string because there are no
  * errors to render.
  *
- * **Example** (rendering a cause)
+ * **Example** (Rendering a cause)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1247,7 +1247,7 @@ export declare const pretty: <E>(cause: Cause<E>) => string;
  * `TimeoutError`, `IllegalArgumentError`, `ExceededCapacityError`,
  * `AsyncFiberError`, and `UnknownError`) implement this interface.
  *
- * **Example** (yielding an error in Effect.gen)
+ * **Example** (Yielding an error in Effect.gen)
  *
  * ```ts
  * import { Cause, Effect } from "effect"
@@ -1269,7 +1269,7 @@ export interface YieldableError extends Error, Pipeable, Inspectable {
 /**
  * Checks whether an arbitrary value is a `NoSuchElementError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1308,7 +1308,7 @@ export declare const NoSuchElementErrorTypeId: "~effect/Cause/NoSuchElementError
  * expected case. This error is mainly for APIs that intentionally turn absence
  * into a thrown value or failed effect.
  *
- * **Example** (creating and checking)
+ * **Example** (Creating and checking a NoSuchElementError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1333,7 +1333,7 @@ export interface NoSuchElementError extends YieldableError {
  * Use to create the error value for APIs that intentionally fail when an
  * expected element is absent.
  *
- * **Example** (creating a NoSuchElementError)
+ * **Example** (Creating a NoSuchElementError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1351,7 +1351,7 @@ export declare const NoSuchElementError: new (message?: string) => NoSuchElement
 /**
  * Checks whether an arbitrary value is a `Done` signal.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1386,7 +1386,7 @@ export declare const DoneTypeId: "~effect/Cause/Done";
  * successful completion. The optional `value` field can carry a final
  * leftover payload.
  *
- * **Example** (signaling queue completion)
+ * **Example** (Signaling queue completion)
  *
  * ```ts
  * import { Cause, Effect, Queue } from "effect"
@@ -1452,7 +1452,7 @@ export declare const Done: <A = void>(value?: A) => Done<A>;
  *
  * Use when you model stream or queue completion through the error channel.
  *
- * **Example** (failing with Done)
+ * **Example** (Failing with Done)
  *
  * ```ts
  * import { Cause, Effect } from "effect"
@@ -1480,7 +1480,7 @@ export declare const TimeoutErrorTypeId: "~effect/Cause/TimeoutError";
 /**
  * Checks whether an arbitrary value is a `TimeoutError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1501,7 +1501,7 @@ export declare const isTimeoutError: (u: unknown) => u is TimeoutError;
  * Produced by `Effect.timeout` and related APIs. Implements
  * `YieldableError`.
  *
- * **Example** (creating and checking)
+ * **Example** (Creating and checking a TimeoutError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1521,7 +1521,7 @@ export interface TimeoutError extends YieldableError {
 /**
  * Constructs a `TimeoutError` with an optional message.
  *
- * **Example** (creating a TimeoutError)
+ * **Example** (Creating a TimeoutError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1544,7 +1544,7 @@ export declare const IllegalArgumentErrorTypeId: "~effect/Cause/IllegalArgumentE
 /**
  * Checks whether an arbitrary value is an `IllegalArgumentError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1565,7 +1565,7 @@ export declare const isIllegalArgumentError: (u: unknown) => u is IllegalArgumen
  *
  * Implements `YieldableError`.
  *
- * **Example** (creating and checking)
+ * **Example** (Creating and checking an IllegalArgumentError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1585,7 +1585,7 @@ export interface IllegalArgumentError extends YieldableError {
 /**
  * Constructs an `IllegalArgumentError` with an optional message.
  *
- * **Example** (creating an IllegalArgumentError)
+ * **Example** (Creating an IllegalArgumentError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1601,7 +1601,7 @@ export declare const IllegalArgumentError: new (message?: string) => IllegalArgu
 /**
  * Checks whether an arbitrary value is an `ExceededCapacityError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1634,7 +1634,7 @@ export declare const ExceededCapacityErrorTypeId: "~effect/Cause/ExceededCapacit
  *
  * Implements `YieldableError`.
  *
- * **Example** (creating and checking)
+ * **Example** (Creating and checking an ExceededCapacityError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1658,7 +1658,7 @@ export interface ExceededCapacityError extends YieldableError {
  *
  * Use to create the error value for bounded-resource capacity failures.
  *
- * **Example** (creating an ExceededCapacityError)
+ * **Example** (Creating an ExceededCapacityError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1684,7 +1684,7 @@ export declare const AsyncFiberErrorTypeId: "~effect/Cause/AsyncFiberError";
 /**
  * Checks whether an arbitrary value is an `AsyncFiberError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1714,7 +1714,7 @@ export declare const isAsyncFiberError: (u: unknown) => u is AsyncFiberError;
  * The `fiber` property stores the fiber that could not be synchronously
  * resolved. This error implements `YieldableError`.
  *
- * **Example** (accessing the fiber)
+ * **Example** (Accessing the fiber)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1744,7 +1744,7 @@ export interface AsyncFiberError extends YieldableError {
  * Use to create the error value for a fiber that could not be completed by a
  * synchronous runner.
  *
- * **Example** (creating an AsyncFiberError)
+ * **Example** (Creating an AsyncFiberError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1772,7 +1772,7 @@ export declare const UnknownErrorTypeId: "~effect/Cause/UnknownError";
 /**
  * Checks whether an arbitrary value is an `UnknownError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1794,7 +1794,7 @@ export declare const isUnknownError: (u: unknown) => u is UnknownError;
  * typed error. The original value is stored in the `cause` property inherited
  * from `Error`. Implements `YieldableError`.
  *
- * **Example** (creating and checking)
+ * **Example** (Creating and checking an UnknownError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1816,7 +1816,7 @@ export interface UnknownError extends YieldableError {
  * cause (stored in `Error.cause`); the second is an optional human-readable
  * message.
  *
- * **Example** (creating an UnknownError)
+ * **Example** (Creating an UnknownError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1846,7 +1846,7 @@ export declare const UnknownError: new (cause: unknown, message?: string) => Unk
  * - By default, existing keys are preserved. Pass `{ overwrite: true }` to
  *   replace them.
  *
- * **Example** (annotating a cause)
+ * **Example** (Annotating a cause)
  *
  * ```ts
  * import { Cause, Context } from "effect"
@@ -1883,7 +1883,7 @@ export declare const annotate: {
      * - By default, existing keys are preserved. Pass `{ overwrite: true }` to
      *   replace them.
      *
-     * **Example** (annotating a cause)
+     * **Example** (Annotating a cause)
      *
      * ```ts
      * import { Cause, Context } from "effect"
@@ -1922,7 +1922,7 @@ export declare const annotate: {
      * - By default, existing keys are preserved. Pass `{ overwrite: true }` to
      *   replace them.
      *
-     * **Example** (annotating a cause)
+     * **Example** (Annotating a cause)
      *
      * ```ts
      * import { Cause, Context } from "effect"
@@ -1953,7 +1953,7 @@ export declare const annotate: {
  * Use when you need tracing metadata (e.g. `StackTrace`) from
  * a specific reason rather than the whole cause.
  *
- * **Example** (reading reason annotations)
+ * **Example** (Reading reason annotations)
  *
  * ```ts
  * import { Cause, Context } from "effect"
@@ -1984,7 +1984,7 @@ export declare const reasonAnnotations: <E>(self: Reason<E>) => Context.Context<
  * When multiple reasons contain the same annotation key, the value from the
  * later reason wins.
  *
- * **Example** (reading merged annotations)
+ * **Example** (Reading merged annotations)
  *
  * ```ts
  * import { Cause, Context } from "effect"