effect 3.13.9 → 3.13.11

package/dist/dts/Either.d.ts

@@ -1123,10 +1123,6 @@ export declare const gen: Gen.Gen<EitherTypeLambda, Gen.Adapter<EitherTypeLambda
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link bind}
- * @see {@link bindTo}
- * @see {@link let_ let}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1141,6 +1137,10 @@ export declare const gen: Gen.Gen<EitherTypeLambda, Gen.Adapter<EitherTypeLambda
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
  * ```
  *
+ * @see {@link bind}
+ * @see {@link bindTo}
+ * @see {@link let_ let}
+ *
  * @category do notation
  * @since 2.0.0
  */
@@ -1155,10 +1155,6 @@ export declare const Do: Either<{}>;
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link Do}
- * @see {@link bindTo}
- * @see {@link let_ let}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1173,6 +1169,10 @@ export declare const Do: Either<{}>;
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
  * ```
  *
+ * @see {@link Do}
+ * @see {@link bindTo}
+ * @see {@link let_ let}
+ *
  * @category do notation
  * @since 2.0.0
  */
@@ -1187,10 +1187,6 @@ export declare const bind: {
      * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
      * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
      *
-     * @see {@link Do}
-     * @see {@link bindTo}
-     * @see {@link let_ let}
-     *
      * @example
      * ```ts
      * import * as assert from "node:assert"
@@ -1205,6 +1201,10 @@ export declare const bind: {
      * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
      * ```
      *
+     * @see {@link Do}
+     * @see {@link bindTo}
+     * @see {@link let_ let}
+     *
      * @category do notation
      * @since 2.0.0
      */
@@ -1221,10 +1221,6 @@ export declare const bind: {
      * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
      * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
      *
-     * @see {@link Do}
-     * @see {@link bindTo}
-     * @see {@link let_ let}
-     *
      * @example
      * ```ts
      * import * as assert from "node:assert"
@@ -1239,6 +1235,10 @@ export declare const bind: {
      * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
      * ```
      *
+     * @see {@link Do}
+     * @see {@link bindTo}
+     * @see {@link let_ let}
+     *
      * @category do notation
      * @since 2.0.0
      */
@@ -1256,10 +1256,6 @@ export declare const bind: {
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link Do}
- * @see {@link bind}
- * @see {@link let_ let}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1274,6 +1270,10 @@ export declare const bind: {
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
  * ```
  *
+ * @see {@link Do}
+ * @see {@link bind}
+ * @see {@link let_ let}
+ *
  * @category do notation
  * @since 2.0.0
  */
@@ -1288,10 +1288,6 @@ export declare const bindTo: {
      * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
      * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
      *
-     * @see {@link Do}
-     * @see {@link bind}
-     * @see {@link let_ let}
-     *
      * @example
      * ```ts
      * import * as assert from "node:assert"
@@ -1306,6 +1302,10 @@ export declare const bindTo: {
      * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
      * ```
      *
+     * @see {@link Do}
+     * @see {@link bind}
+     * @see {@link let_ let}
+     *
      * @category do notation
      * @since 2.0.0
      */
@@ -1322,10 +1322,6 @@ export declare const bindTo: {
      * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
      * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
      *
-     * @see {@link Do}
-     * @see {@link bind}
-     * @see {@link let_ let}
-     *
      * @example
      * ```ts
      * import * as assert from "node:assert"
@@ -1340,6 +1336,10 @@ export declare const bindTo: {
      * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
      * ```
      *
+     * @see {@link Do}
+     * @see {@link bind}
+     * @see {@link let_ let}
+     *
      * @category do notation
      * @since 2.0.0
      */
@@ -1366,10 +1366,6 @@ export {
  * 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
  * 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
  *
- * @see {@link Do}
- * @see {@link bindTo}
- * @see {@link bind}
- *
  * @example
  * ```ts
  * import * as assert from "node:assert"
@@ -1382,8 +1378,12 @@ export {
  *   Either.let("sum", ({ x, y }) => x + y)
  * )
  * assert.deepStrictEqual(result, Either.right({ x: 2, y: 3, sum: 5 }))
- *
  * ```
+ *
+ * @see {@link Do}
+ * @see {@link bindTo}
+ * @see {@link bind}
+ *
  * @category do notation
  * @since 2.0.0
  */

package/dist/dts/LogLevel.d.ts

@@ -173,7 +173,7 @@ export declare const allLevels: readonly LogLevel[];
  *   }).pipe(LogLevel.locally(LogLevel.Warning))
  * })
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // timestamp=... level=INFO fiber=#0 message=message1
  * // timestamp=... level=WARN fiber=#0 message=message2
  * // timestamp=... level=WARN fiber=#0 message=message3
@@ -209,7 +209,7 @@ export declare const locally: {
      *   }).pipe(LogLevel.locally(LogLevel.Warning))
      * })
      *
-     * // Effect.runFork(program)
+     * Effect.runFork(program)
      * // timestamp=... level=INFO fiber=#0 message=message1
      * // timestamp=... level=WARN fiber=#0 message=message2
      * // timestamp=... level=WARN fiber=#0 message=message3
@@ -245,7 +245,7 @@ export declare const locally: {
      *   }).pipe(LogLevel.locally(LogLevel.Warning))
      * })
      *
-     * // Effect.runFork(program)
+     * Effect.runFork(program)
      * // timestamp=... level=INFO fiber=#0 message=message1
      * // timestamp=... level=WARN fiber=#0 message=message2
      * // timestamp=... level=WARN fiber=#0 message=message3

package/dist/dts/Logger.d.ts

@@ -87,7 +87,7 @@ export declare namespace Logger {
  *   Effect.provide(Logger.replace(Logger.defaultLogger, logger))
  * )
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // [INFO] start
  * // [DEBUG] task1 done
  * // [DEBUG] task2 done
@@ -207,7 +207,7 @@ export declare const map: {
  *   yield* Effect.log("three")
  * }).pipe(Effect.provide(LoggerLive))
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // BATCH [
  * // timestamp=... level=INFO fiber=#0 message=one
  * // timestamp=... level=INFO fiber=#0 message=two
@@ -240,7 +240,7 @@ export declare const batched: {
      *   yield* Effect.log("three")
      * }).pipe(Effect.provide(LoggerLive))
      *
-     * // Effect.runFork(program)
+     * Effect.runFork(program)
      * // BATCH [
      * // timestamp=... level=INFO fiber=#0 message=one
      * // timestamp=... level=INFO fiber=#0 message=two
@@ -273,7 +273,7 @@ export declare const batched: {
      *   yield* Effect.log("three")
      * }).pipe(Effect.provide(LoggerLive))
      *
-     * // Effect.runFork(program)
+     * Effect.runFork(program)
      * // BATCH [
      * // timestamp=... level=INFO fiber=#0 message=one
      * // timestamp=... level=INFO fiber=#0 message=two
@@ -420,7 +420,7 @@ export declare const test: {
  *
  * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
  *
- * // Effect.runFork(program)
+ * Effect.runFork(program)
  * // timestamp=... level=DEBUG fiber=#0 message=message1
  * ```
  *
@@ -438,7 +438,7 @@ export declare const withMinimumLogLevel: {
      *
      * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
      *
-     * // Effect.runFork(program)
+     * Effect.runFork(program)
      * // timestamp=... level=DEBUG fiber=#0 message=message1
      * ```
      *
@@ -456,7 +456,7 @@ export declare const withMinimumLogLevel: {
      *
      * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
      *
-     * // Effect.runFork(program)
+     * Effect.runFork(program)
      * // timestamp=... level=DEBUG fiber=#0 message=message1
      * ```
      *
@@ -545,7 +545,7 @@ export declare const defaultLogger: Logger<unknown, void>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.json)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.json)))
  * // {"message":["message1","message2"],"logLevel":"INFO","timestamp":"...","annotations":{"key2":"value2","key1":"value1"},"spans":{"myspan":0},"fiberId":"#0"}
  * ```
  *
@@ -566,7 +566,7 @@ export declare const jsonLogger: Logger<unknown, string>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
  * // timestamp=... level=INFO fiber=#0 message=message1 message=message2 myspan=0ms key2=value2 key1=value1
  * ```
  *
@@ -594,7 +594,7 @@ export declare const stringLogger: Logger<unknown, string>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
  * //         green --v                      v-- bold and cyan
  * // [07:51:54.434] INFO (#0) myspan=1ms: message1
  * //   message2
@@ -633,7 +633,7 @@ export declare const prettyLoggerDefault: Logger<unknown, void>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
  * // {
  * //   message: [ 'message1', 'message2' ],
  * //   logLevel: 'INFO',
@@ -675,7 +675,7 @@ export declare const tracerLogger: Logger<unknown, void>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.json)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.json)))
  * // {"message":["message1","message2"],"logLevel":"INFO","timestamp":"...","annotations":{"key2":"value2","key1":"value1"},"spans":{"myspan":0},"fiberId":"#0"}
  * ```
  *
@@ -696,7 +696,7 @@ export declare const json: Layer.Layer<never>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
  * // timestamp=... level=INFO fiber=#0 message=message1 message=message2 myspan=0ms key2=value2 key1=value1
  * ```
  *
@@ -719,7 +719,7 @@ export declare const logFmt: Layer.Layer<never>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.pretty)))
  * //         green --v                      v-- bold and cyan
  * // [07:51:54.434] INFO (#0) myspan=1ms: message1
  * //   message2
@@ -746,7 +746,7 @@ export declare const pretty: Layer.Layer<never>;
  *   Effect.withLogSpan("myspan")
  * )
  *
- * // Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.structured)))
  * // {
  * //   message: [ 'message1', 'message2' ],
  * //   logLevel: 'INFO',
@@ -777,7 +777,7 @@ export declare const structured: Layer.Layer<never>;
  * })
  *
  * // Logging disabled using a layer
- * // Effect.runFork(program.pipe(Effect.provide(Logger.minimumLogLevel(LogLevel.None))))
+ * Effect.runFork(program.pipe(Effect.provide(Logger.minimumLogLevel(LogLevel.None))))
  * // task done
  * ```
  *

package/dist/dts/Match.d.ts

@@ -146,11 +146,9 @@ export interface Not {
  * created, you can use pattern-matching functions like {@link when} to define
  * how different values should be processed.
  *
- * @see {@link value} for creating a matcher from a specific value.
+ * **Example** (Matching Numbers and Strings)
  *
- * @example
  * ```ts
- * // Title: Matching Numbers and Strings
  * import { Match } from "effect"
  *
  * // Create a matcher for values that are either strings or numbers
@@ -173,6 +171,8 @@ export interface Not {
  * // Output: "string: hello"
  * ```
  *
+ * @see {@link value} for creating a matcher from a specific value.
+ *
  * @category Creating a matcher
  * @since 1.0.0
  */
@@ -190,11 +190,9 @@ export declare const type: <I>() => Matcher<I, Types.Without<never>, I, never, n
  * Once the matcher is created, you can use pattern-matching functions like
  * {@link when} to define how different cases should be handled.
  *
- * @see {@link type} for creating a matcher from a specific type.
+ * **Example** (Matching an Object by Property)
  *
- * @example
  * ```ts
- * // Title: Matching an Object by Property
  * import { Match } from "effect"
  *
  * const input = { name: "John", age: 30 }
@@ -214,6 +212,8 @@ export declare const type: <I>() => Matcher<I, Types.Without<never>, I, never, n
  * // Output: "John is 30 years old"
  * ```
  *
+ * @see {@link type} for creating a matcher from a specific type.
+ *
  * @category Creating a matcher
  * @since 1.0.0
  */
@@ -252,9 +252,9 @@ export declare const typeTags: <I>() => <P extends {
  * **Important:** This function must be the first step in the matcher pipeline.
  * If used later, TypeScript will not enforce type consistency correctly.
  *
- * @example
+ * **Example** (Validating Return Type Consistency)
+ *
  * ```ts
- * // Title: Validating Return Type Consistency
  * import { Match } from "effect"
  *
  * const match = Match.type<{ a: number } | { b: string }>().pipe(
@@ -286,14 +286,9 @@ export declare const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(self: Matche
  * specific values or apply logical conditions to determine a match. It works
  * well with structured objects and primitive types.
  *
- * @see {@link whenOr} Use this when multiple patterns should match in a single
- * condition.
- * @see {@link whenAnd} Use this when a value must match all provided patterns.
- * @see {@link orElse} Provides a fallback when no patterns match.
+ * **Example** (Matching with Values and Predicates)
  *
- * @example
  * ```ts
- * // Title: Matching with Values and Predicates
  * import { Match } from "effect"
  *
  * // Create a matcher for objects with an "age" property
@@ -316,6 +311,11 @@ export declare const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(self: Matche
  * // Output: "4 is too young"
  * ```
  *
+ * @see {@link whenOr} Use this when multiple patterns should match in a single
+ * condition.
+ * @see {@link whenAnd} Use this when a value must match all provided patterns.
+ * @see {@link orElse} Provides a fallback when no patterns match.
+ *
  * @category Defining patterns
  * @since 1.0.0
  */
@@ -549,9 +549,9 @@ export declare const discriminatorsExhaustive: <D extends string>(field: D) => <
  * of naming the tag field as `"_tag"`. Ensure that your discriminated unions
  * follow this naming convention for proper functionality.
  *
- * @example
+ * **Example** (Matching a Discriminated Union by Tag)
+ *
  * ```ts
- * // Title: Matching a Discriminated Union by Tag
  * import { Match } from "effect"
  *
  * type Event =
@@ -691,9 +691,9 @@ export declare const tagsExhaustive: <R, Ret, P extends {
  * Any excluded value will bypass the provided function and continue matching
  * through other cases.
  *
- * @example
+ * **Example** (Ignoring a Specific Value)
+ *
  * ```ts
- * // Title: Ignoring a Specific Value
  * import { Match } from "effect"
  *
  * // Create a matcher for string or number values
@@ -834,9 +834,9 @@ export declare const instanceOfUnsafe: <A extends abstract new (...args: any) =>
  * `default` clause in a `switch` statement or the final `else` in an `if-else`
  * chain.
  *
- * @example
+ * **Example** (Providing a Default Value When No Patterns Match)
+ *
  * ```ts
- * // Title: Providing a Default Value When No Patterns Match
  * import { Match } from "effect"
  *
  * // Create a matcher for string or number values
@@ -890,9 +890,9 @@ export declare const orElseAbsurd: <I, R, RA, A, Pr, Ret>(self: Matcher<I, R, RA
  * unmatched case should be explicitly handled rather than returning a default
  * value or throwing an error.
  *
- * @example
+ * **Example** (Extracting a User Role with `Match.either`)
+ *
  * ```ts
- * // Title: Extracting a User Role with Either
  * import { Match } from "effect"
  *
  * type User = { readonly role: "admin" | "editor" | "viewer" }
@@ -928,9 +928,9 @@ export declare const either: <I, F, R, A, Pr, Ret>(self: Matcher<I, F, R, A, Pr,
  * handled explicitly rather than throwing an error or returning a default
  * value.
  *
- * @example
+ * **Example** (Extracting a User Role with `Match.option`)
+ *
  * ```ts
- * // Title: Extracting a User Role with Option
  * import { Match } from "effect"
  *
  * type User = { readonly role: "admin" | "editor" | "viewer" }
@@ -959,9 +959,9 @@ export declare const option: <I, F, R, A, Pr, Ret>(self: Matcher<I, F, R, A, Pr,
  * TypeScript will produce a type error. This is particularly useful when
  * working with unions, as it helps prevent unintended gaps in pattern matching.
  *
- * @example
+ * **Example** (Ensuring All Cases Are Covered)
+ *
  * ```ts
- * // Title: Ensuring All Cases Are Covered
  * import { Match } from "effect"
  *
  * // Create a matcher for string or number values