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

package/src/PubSub.ts

@@ -768,7 +768,7 @@ export const shutdown = <A>(self: PubSub<A>): Effect.Effect<void> =>
  * Checks effectfully whether `shutdown` has been called, returning `true`
  * after shutdown and `false` otherwise.
  *
- * **Example** (Checking whether a PubSub is shutdown)
+ * **Example** (Checking whether a PubSub is shut down)
  *
  * ```ts
  * import { Effect, PubSub } from "effect"
@@ -2867,7 +2867,7 @@ export class BackPressureStrategy<in out A> implements PubSub.Strategy<A> {
  *
  * Subscribers may miss messages published while they are subscribed.
  *
- * **Example** (Using a dropping strategy)
+ * **Example** (Applying a dropping strategy)
  *
  * ```ts
  * import { Effect, PubSub } from "effect"
@@ -2954,7 +2954,7 @@ export class DroppingStrategy<in out A> implements PubSub.Strategy<A> {
  * Slow subscribers may miss older messages that are evicted before they are
  * consumed.
  *
- * **Example** (Using a sliding strategy)
+ * **Example** (Applying a sliding strategy)
  *
  * ```ts
  * import { Effect, PubSub } from "effect"

package/src/Reducer.ts

@@ -87,7 +87,7 @@ export interface Reducer<A> extends Combiner.Combiner<A> {
  *   `initialValue` is used.
  * - If `combineAll` is provided, it completely replaces the default fold.
  *
- * **Example** (Multiplication with short-circuit)
+ * **Example** (Multiplying with short-circuit)
  *
  * ```ts
  * import { Reducer } from "effect"

package/src/Result.ts

@@ -328,7 +328,7 @@ export {
    * This is equivalent to `Result.succeed(undefined)`, but reuses a shared
    * `Success` wrapper instead of allocating one each time.
    *
-   * **Example** (Using void result)
+   * **Example** (Referencing void results)
    *
    * ```ts
    * import { Result } from "effect"
@@ -361,7 +361,7 @@ export {
  * `Result<never, void>`, but reuses a shared `Failure` wrapper instead of
  * allocating one each time.
  *
- * **Example** (Using a failure without a payload)
+ * **Example** (Failing without a payload)
  *
  * ```ts
  * import { Result } from "effect"
@@ -706,7 +706,7 @@ export const isResult: (input: unknown) => input is Result<unknown, unknown> = r
  * - Acts as a TypeScript type guard, narrowing to `Failure<A, E>`
  * - After narrowing, you can access `.failure` to read the error value
  *
- * **Example** (Narrowing to Failure)
+ * **Example** (Narrowing to failure)
  *
  * ```ts
  * import { Result } from "effect"
@@ -739,7 +739,7 @@ export const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A, E> = re
  * - Acts as a TypeScript type guard, narrowing to `Success<A, E>`
  * - After narrowing, you can access `.success` to read the value
  *
- * **Example** (Narrowing to Success)
+ * **Example** (Narrowing to success)
  *
  * ```ts
  * import { Result } from "effect"
@@ -2231,7 +2231,7 @@ export const orElse: {
  * - The error types are merged into a union (`E | E2`)
  * - This is the monadic `bind` / `>>=` for `Result`
  *
- * **Example** (Sequential validation)
+ * **Example** (Validating sequentially)
  *
  * ```ts
  * import { pipe, Result } from "effect"
@@ -2268,7 +2268,7 @@ export const flatMap: {
    * - The error types are merged into a union (`E | E2`)
    * - This is the monadic `bind` / `>>=` for `Result`
    *
-   * **Example** (Sequential validation)
+   * **Example** (Validating sequentially)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2305,7 +2305,7 @@ export const flatMap: {
    * - The error types are merged into a union (`E | E2`)
    * - This is the monadic `bind` / `>>=` for `Result`
    *
-   * **Example** (Sequential validation)
+   * **Example** (Validating sequentially)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2351,7 +2351,7 @@ export const flatMap: {
  *
  * If `self` is a `Failure`, the second argument is never evaluated.
  *
- * **Example** (Using andThen with different argument types)
+ * **Example** (Chaining Result values with different argument types)
  *
  * ```ts
  * import { pipe, Result } from "effect"
@@ -2399,7 +2399,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2447,7 +2447,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2495,7 +2495,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2543,7 +2543,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2591,7 +2591,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2639,7 +2639,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2687,7 +2687,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -2735,7 +2735,7 @@ export const andThen: {
    *
    * If `self` is a `Failure`, the second argument is never evaluated.
    *
-   * **Example** (Using andThen with different argument types)
+   * **Example** (Chaining Result values with different argument types)
    *
    * ```ts
    * import { pipe, Result } from "effect"
@@ -3310,7 +3310,7 @@ export const transposeOption = <A = never, E = never>(
  * - `Some(a)` where `f(a)` is `Success(b)` becomes `Success(Some(b))`
  * - `Some(a)` where `f(a)` is `Failure(e)` becomes `Failure(e)`
  *
- * **Example** (Map and transpose in one step)
+ * **Example** (Mapping and transposing in one step)
  *
  * ```ts
  * import { Option, Result } from "effect"
@@ -3348,7 +3348,7 @@ export const transposeMapOption = dual<
    * - `Some(a)` where `f(a)` is `Success(b)` becomes `Success(Some(b))`
    * - `Some(a)` where `f(a)` is `Failure(e)` becomes `Failure(e)`
    *
-   * **Example** (Map and transpose in one step)
+   * **Example** (Mapping and transposing in one step)
    *
    * ```ts
    * import { Option, Result } from "effect"
@@ -3386,7 +3386,7 @@ export const transposeMapOption = dual<
    * - `Some(a)` where `f(a)` is `Success(b)` becomes `Success(Some(b))`
    * - `Some(a)` where `f(a)` is `Failure(e)` becomes `Failure(e)`
    *
-   * **Example** (Map and transpose in one step)
+   * **Example** (Mapping and transposing in one step)
    *
    * ```ts
    * import { Option, Result } from "effect"
@@ -3424,7 +3424,7 @@ export const transposeMapOption = dual<
  * This is equivalent to `Result.succeed(Option.none())`, but reuses a shared
  * `Success` wrapper instead of allocating one each time.
  *
- * **Example** (Using succeedNone)
+ * **Example** (Succeeding with None)
  *
  * ```ts
  * import { Result } from "effect"

package/src/Runtime.ts

@@ -88,7 +88,7 @@ export interface Teardown {
  * The `130` code is used only when the Cause contains interruptions and no
  * other failure reasons. Mixed causes use the squashed error path instead.
  *
- * **Example** (Using default teardown)
+ * **Example** (Referencing default teardown)
  *
  * ```ts
  * import { Exit, Runtime } from "effect"