effect 4.0.0-beta.83 → 4.0.0-beta.85

package/dist/Cause.js

@@ -29,7 +29,7 @@ export const ReasonTypeId = core.CauseReasonTypeId;
 /**
  * Checks whether an arbitrary value is a `Cause`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -45,7 +45,7 @@ export const isCause = core.isCause;
 /**
  * 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"
@@ -67,7 +67,7 @@ export const isReason = core.isCauseReason;
  * 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"
@@ -92,7 +92,7 @@ export const isFailReason = core.isFailReason;
  * 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"
@@ -117,7 +117,7 @@ export const isDieReason = core.isDieReason;
  * 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"
@@ -153,7 +153,7 @@ export const isInterruptReason = core.isInterruptReason;
  * 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"
@@ -185,7 +185,7 @@ export const fromReasons = core.causeFromReasons;
  * 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"
@@ -210,7 +210,7 @@ export const empty = core.causeEmpty;
  *
  * 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"
@@ -235,7 +235,7 @@ export const fail = core.causeFail;
  *
  * 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"
@@ -256,7 +256,7 @@ export const die = core.causeDie;
  * 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"
@@ -281,7 +281,7 @@ export const interrupt = effect.causeInterrupt;
  * 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"
@@ -306,7 +306,7 @@ export const makeFailReason = error => new core.Fail(error);
  * 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"
@@ -332,7 +332,7 @@ export const makeDieReason = defect => new core.Die(defect);
  * 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"
@@ -357,7 +357,7 @@ export const makeInterruptReason = effect.makeInterruptReason;
  *
  * 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"
@@ -389,7 +389,7 @@ export const hasInterruptsOnly = effect.hasInterruptsOnly;
  * 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"
@@ -420,7 +420,7 @@ export const map = effect.causeMap;
  * - 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"
@@ -462,7 +462,7 @@ export const combine = effect.causeCombine;
  * 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"
@@ -486,7 +486,7 @@ export const squash = effect.causeSquash;
  * 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"
@@ -513,7 +513,7 @@ export const hasFails = effect.hasFails;
  * 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"
@@ -542,7 +542,7 @@ export const findFail = effect.findFail;
  * 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"
@@ -569,7 +569,7 @@ export const findError = effect.findError;
  * 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"
@@ -595,7 +595,7 @@ export const findErrorOption = effect.findErrorOption;
  * 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"
@@ -621,7 +621,7 @@ export const hasDies = effect.hasDies;
  * 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"
@@ -649,7 +649,7 @@ export const findDie = effect.findDie;
  * 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"
@@ -670,7 +670,7 @@ export const findDefect = effect.findDefect;
 /**
  * Returns `true` if the cause contains at least one `Interrupt` reason.
  *
- * **Example** (checking for interruptions)
+ * **Example** (Checking for interruptions)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -697,7 +697,7 @@ export const hasInterrupts = effect.hasInterrupts;
  * 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"
@@ -724,7 +724,7 @@ export const findInterrupt = effect.findInterrupt;
  * 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"
@@ -759,7 +759,7 @@ export const interruptors = effect.causeInterruptors;
  * 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"
@@ -803,7 +803,7 @@ export const filterInterruptors = effect.causeFilterInterruptors;
  *
  * An empty cause returns an empty array.
  *
- * **Example** (converting a cause to errors)
+ * **Example** (Converting a cause to errors)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -850,7 +850,7 @@ export const prettyErrors = effect.causePrettyErrors;
  * 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"
@@ -868,7 +868,7 @@ export const pretty = effect.causePretty;
 /**
  * Checks whether an arbitrary value is a `NoSuchElementError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -896,7 +896,7 @@ export const NoSuchElementErrorTypeId = core.NoSuchElementErrorTypeId;
  * 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"
@@ -914,7 +914,7 @@ export const NoSuchElementError = core.NoSuchElementError;
 /**
  * Checks whether an arbitrary value is a `Done` signal.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -955,7 +955,7 @@ export const Done = core.Done;
  *
  * 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"
@@ -983,7 +983,7 @@ export const TimeoutErrorTypeId = effect.TimeoutErrorTypeId;
 /**
  * Checks whether an arbitrary value is a `TimeoutError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -999,7 +999,7 @@ export const isTimeoutError = effect.isTimeoutError;
 /**
  * Constructs a `TimeoutError` with an optional message.
  *
- * **Example** (creating a TimeoutError)
+ * **Example** (Creating a TimeoutError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1022,7 +1022,7 @@ export const IllegalArgumentErrorTypeId = effect.IllegalArgumentErrorTypeId;
 /**
  * Checks whether an arbitrary value is an `IllegalArgumentError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1038,7 +1038,7 @@ export const isIllegalArgumentError = effect.isIllegalArgumentError;
 /**
  * Constructs an `IllegalArgumentError` with an optional message.
  *
- * **Example** (creating an IllegalArgumentError)
+ * **Example** (Creating an IllegalArgumentError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1054,7 +1054,7 @@ export const IllegalArgumentError = effect.IllegalArgumentError;
 /**
  * Checks whether an arbitrary value is an `ExceededCapacityError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1081,7 +1081,7 @@ export const ExceededCapacityErrorTypeId = effect.ExceededCapacityErrorTypeId;
  *
  * Use to create the error value for bounded-resource capacity failures.
  *
- * **Example** (creating an ExceededCapacityError)
+ * **Example** (Creating an ExceededCapacityError)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1107,7 +1107,7 @@ export const AsyncFiberErrorTypeId = effect.AsyncFiberErrorTypeId;
 /**
  * Checks whether an arbitrary value is an `AsyncFiberError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1133,7 +1133,7 @@ export const isAsyncFiberError = effect.isAsyncFiberError;
  * 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"
@@ -1161,7 +1161,7 @@ export const UnknownErrorTypeId = effect.UnknownErrorTypeId;
 /**
  * Checks whether an arbitrary value is an `UnknownError`.
  *
- * **Example** (runtime type check)
+ * **Example** (Checking the runtime type)
  *
  * ```ts
  * import { Cause } from "effect"
@@ -1179,7 +1179,7 @@ export const isUnknownError = effect.isUnknownError;
  * 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"
@@ -1209,7 +1209,7 @@ export const UnknownError = effect.UnknownError;
  * - 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"
@@ -1237,7 +1237,7 @@ export const annotate = core.causeAnnotate;
  * 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"
@@ -1268,7 +1268,7 @@ export const reasonAnnotations = effect.reasonAnnotations;
  * 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"

package/dist/Channel.d.ts

@@ -658,7 +658,7 @@ export declare const sync: <A>(evaluate: LazyArg<A>) => Channel<A>;
 /**
  * Represents a `Channel` that emits no elements.
  *
- * **Example** (Using empty channels)
+ * **Example** (Creating empty channels)
  *
  * ```ts
  * import { Channel } from "effect"
@@ -682,7 +682,7 @@ export declare const empty: Channel<never>;
 /**
  * Represents a `Channel` that never completes.
  *
- * **Example** (Using non-terminating channels)
+ * **Example** (Creating non-terminating channels)
  *
  * ```ts
  * import { Channel } from "effect"
@@ -1964,7 +1964,7 @@ export declare const tap: {
  * sequentially. Use `options.concurrency` and `options.bufferSize` to run child
  * channels concurrently.
  *
- * **Example** (FlatMapping channel output)
+ * **Example** (Flat mapping channel output)
  *
  * ```ts
  * import { Channel, Data } from "effect"
@@ -2002,7 +2002,7 @@ export declare const flatMap: {
      * sequentially. Use `options.concurrency` and `options.bufferSize` to run child
      * channels concurrently.
      *
-     * **Example** (FlatMapping channel output)
+     * **Example** (Flat mapping channel output)
      *
      * ```ts
      * import { Channel, Data } from "effect"
@@ -2043,7 +2043,7 @@ export declare const flatMap: {
      * sequentially. Use `options.concurrency` and `options.bufferSize` to run child
      * channels concurrently.
      *
-     * **Example** (FlatMapping channel output)
+     * **Example** (Flat mapping channel output)
      *
      * ```ts
      * import { Channel, Data } from "effect"

package/dist/Channel.js

@@ -532,7 +532,7 @@ export const sync = evaluate => fromEffect(Effect.sync(evaluate));
 /**
  * Represents a `Channel` that emits no elements.
  *
- * **Example** (Using empty channels)
+ * **Example** (Creating empty channels)
  *
  * ```ts
  * import { Channel } from "effect"
@@ -556,7 +556,7 @@ export const empty = /*#__PURE__*/fromPull(/*#__PURE__*/Effect.succeed(/*#__PURE
 /**
  * Represents a `Channel` that never completes.
  *
- * **Example** (Using non-terminating channels)
+ * **Example** (Creating non-terminating channels)
  *
  * ```ts
  * import { Channel } from "effect"
@@ -1558,7 +1558,7 @@ export const tap = /*#__PURE__*/dual(args => isChannel(args[0]), (self, f, optio
  * sequentially. Use `options.concurrency` and `options.bufferSize` to run child
  * channels concurrently.
  *
- * **Example** (FlatMapping channel output)
+ * **Example** (Flat mapping channel output)
  *
  * ```ts
  * import { Channel, Data } from "effect"

package/dist/Clock.d.ts

@@ -114,7 +114,7 @@ export declare const Clock: Context.Reference<Clock>;
  * Use when you need the full Clock service interface to perform multiple time
  * operations or call unsafe variants within a single effect.
  *
- * **Example** (Using the current Clock service)
+ * **Example** (Accessing the current Clock service)
  *
  * ```ts
  * import { Clock, Effect } from "effect"

package/dist/Clock.js

@@ -34,7 +34,7 @@ export const Clock = effect.ClockRef;
  * Use when you need the full Clock service interface to perform multiple time
  * operations or call unsafe variants within a single effect.
  *
- * **Example** (Using the current Clock service)
+ * **Example** (Accessing the current Clock service)
  *
  * ```ts
  * import { Clock, Effect } from "effect"

package/dist/Combiner.d.ts

@@ -23,7 +23,7 @@ import type * as Order from "./Order.ts";
  * `Struct.makeCombiner` or `Option.makeCombinerFailFast`, or define the
  * combining step for a `Reducer`.
  *
- * **Example** (number addition combiner)
+ * **Example** (Combining numbers with addition)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -61,7 +61,7 @@ export interface Combiner<A> {
  * The returned combiner's `combine` method delegates to the provided function.
  * Any purity, associativity, or mutation behavior comes from that function.
  *
- * **Example** (multiplying numbers)
+ * **Example** (Multiplying numbers)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -90,7 +90,7 @@ export declare function make<A>(combine: (self: A, that: A) => A): Combiner<A>;
  * Returns a new `Combiner` where `combine(self, that)` calls the original
  * combiner as `combine(that, self)`.
  *
- * **Example** (reversing string concatenation)
+ * **Example** (Reversing string concatenation)
  *
  * ```ts
  * import { Combiner, String } from "effect"
@@ -120,7 +120,7 @@ export declare function flip<A>(combiner: Combiner<A>): Combiner<A>;
  * The combiner compares values using the given `Order`. When values are equal,
  * it returns `that` (the second argument).
  *
- * **Example** (minimum of two numbers)
+ * **Example** (Selecting the minimum of two numbers)
  *
  * ```ts
  * import { Combiner, Number } from "effect"
@@ -153,7 +153,7 @@ export declare function min<A>(order: Order.Order<A>): Combiner<A>;
  * The combiner compares values using the given `Order`. When values are equal,
  * it returns `that` (the second argument).
  *
- * **Example** (maximum of two numbers)
+ * **Example** (Selecting the maximum of two numbers)
  *
  * ```ts
  * import { Combiner, Number } from "effect"
@@ -183,7 +183,7 @@ export declare function max<A>(order: Order.Order<A>): Combiner<A>;
  *
  * `combine(self, that)` returns `self` and ignores `that`.
  *
- * **Example** (keeping the first value)
+ * **Example** (Keeping the first value)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -210,7 +210,7 @@ export declare function first<A>(): Combiner<A>;
  *
  * `combine(self, that)` returns `that` and ignores `self`.
  *
- * **Example** (keeping the last value)
+ * **Example** (Keeping the last value)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -239,7 +239,7 @@ export declare function last<A>(): Combiner<A>;
  *
  * `combine(self, that)` returns the constant `a` and ignores both arguments.
  *
- * **Example** (always returning zero)
+ * **Example** (Always returning zero)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -272,7 +272,7 @@ export declare function constant<A>(a: A): Combiner<A>;
  * `combiner.combine(self, combiner.combine(middle, that))`. This function is
  * curried: first provide the separator, then the base combiner.
  *
- * **Example** (joining strings with a separator)
+ * **Example** (Joining strings with a separator)
  *
  * ```ts
  * import { Combiner, String } from "effect"

package/dist/Combiner.js

@@ -11,7 +11,7 @@
  * The returned combiner's `combine` method delegates to the provided function.
  * Any purity, associativity, or mutation behavior comes from that function.
  *
- * **Example** (multiplying numbers)
+ * **Example** (Multiplying numbers)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -44,7 +44,7 @@ export function make(combine) {
  * Returns a new `Combiner` where `combine(self, that)` calls the original
  * combiner as `combine(that, self)`.
  *
- * **Example** (reversing string concatenation)
+ * **Example** (Reversing string concatenation)
  *
  * ```ts
  * import { Combiner, String } from "effect"
@@ -76,7 +76,7 @@ export function flip(combiner) {
  * The combiner compares values using the given `Order`. When values are equal,
  * it returns `that` (the second argument).
  *
- * **Example** (minimum of two numbers)
+ * **Example** (Selecting the minimum of two numbers)
  *
  * ```ts
  * import { Combiner, Number } from "effect"
@@ -111,7 +111,7 @@ export function min(order) {
  * The combiner compares values using the given `Order`. When values are equal,
  * it returns `that` (the second argument).
  *
- * **Example** (maximum of two numbers)
+ * **Example** (Selecting the maximum of two numbers)
  *
  * ```ts
  * import { Combiner, Number } from "effect"
@@ -143,7 +143,7 @@ export function max(order) {
  *
  * `combine(self, that)` returns `self` and ignores `that`.
  *
- * **Example** (keeping the first value)
+ * **Example** (Keeping the first value)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -172,7 +172,7 @@ export function first() {
  *
  * `combine(self, that)` returns `that` and ignores `self`.
  *
- * **Example** (keeping the last value)
+ * **Example** (Keeping the last value)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -203,7 +203,7 @@ export function last() {
  *
  * `combine(self, that)` returns the constant `a` and ignores both arguments.
  *
- * **Example** (always returning zero)
+ * **Example** (Always returning zero)
  *
  * ```ts
  * import { Combiner } from "effect"
@@ -238,7 +238,7 @@ export function constant(a) {
  * `combiner.combine(self, combiner.combine(middle, that))`. This function is
  * curried: first provide the separator, then the base combiner.
  *
- * **Example** (joining strings with a separator)
+ * **Example** (Joining strings with a separator)
  *
  * ```ts
  * import { Combiner, String } from "effect"