effect 3.10.18 → 3.11.0

package/src/List.ts

@@ -349,12 +349,14 @@ export const append: {
  * If either list is non-empty, the result is also a non-empty list.
  *
  * @example
+ * ```ts
  * import { List } from "effect"
  *
  * assert.deepStrictEqual(
  *   List.make(1, 2).pipe(List.appendAll(List.make("a", "b")), List.toArray),
  *   [1, 2, "a", "b"]
  * )
+ * ```
  *
  * @category concatenating
  * @since 2.0.0
@@ -365,12 +367,14 @@ export const appendAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.appendAll(List.make("a", "b")), List.toArray),
    *   [1, 2, "a", "b"]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -381,12 +385,14 @@ export const appendAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.appendAll(List.make("a", "b")), List.toArray),
    *   [1, 2, "a", "b"]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -397,12 +403,14 @@ export const appendAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.appendAll(List.make("a", "b")), List.toArray),
    *   [1, 2, "a", "b"]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -413,12 +421,14 @@ export const appendAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.appendAll(List.make("a", "b")), List.toArray),
    *   [1, 2, "a", "b"]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -463,12 +473,14 @@ export const prepend: {
  * If either list is non-empty, the result is also a non-empty list.
  *
  * @example
+ * ```ts
  * import { List } from "effect"
  *
  * assert.deepStrictEqual(
  *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
  *   ["a", "b", 1, 2]
  * )
+ * ```
  *
  * @category concatenating
  * @since 2.0.0
@@ -479,12 +491,14 @@ export const prependAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
    *   ["a", "b", 1, 2]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -495,12 +509,14 @@ export const prependAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
    *   ["a", "b", 1, 2]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -511,12 +527,14 @@ export const prependAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
    *   ["a", "b", 1, 2]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -527,12 +545,14 @@ export const prependAll: {
    * If either list is non-empty, the result is also a non-empty list.
    *
    * @example
+   * ```ts
    * import { List } from "effect"
    *
    * assert.deepStrictEqual(
    *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
    *   ["a", "b", 1, 2]
    * )
+   * ```
    *
    * @category concatenating
    * @since 2.0.0
@@ -550,12 +570,14 @@ export const prependAll: {
        * If either list is non-empty, the result is also a non-empty list.
        *
        * @example
+       * ```ts
        * import { List } from "effect"
        *
        * assert.deepStrictEqual(
        *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
        *   ["a", "b", 1, 2]
        * )
+       * ```
        *
        * @category concatenating
        * @since 2.0.0
@@ -571,12 +593,14 @@ export const prependAll: {
          * If either list is non-empty, the result is also a non-empty list.
          *
          * @example
+         * ```ts
          * import { List } from "effect"
          *
          * assert.deepStrictEqual(
          *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),
          *   ["a", "b", 1, 2]
          * )
+         * ```
          *
          * @category concatenating
          * @since 2.0.0

package/src/Logger.ts

@@ -77,6 +77,7 @@ export declare namespace Logger {
  * function.
  *
  * @example
+ * ```ts
  * import { Effect, Logger, LogLevel } from "effect"
  *
  * const logger = Logger.make(({ logLevel, message }) => {
@@ -101,6 +102,7 @@ export declare namespace Logger {
  * // [DEBUG] task1 done
  * // [DEBUG] task2 done
  * // [INFO] done
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -230,6 +232,7 @@ export const map: {
  * @param window - The time window in which to batch log messages.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Logger } from "effect"
  *
  * const LoggerLive = Logger.replaceScoped(
@@ -251,6 +254,7 @@ export const map: {
  * // timestamp=... level=INFO fiber=#0 message=two
  * // timestamp=... level=INFO fiber=#0 message=three
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -263,6 +267,7 @@ export const batched: {
    * @param window - The time window in which to batch log messages.
    *
    * @example
+   * ```ts
    * import { Console, Effect, Logger } from "effect"
    *
    * const LoggerLive = Logger.replaceScoped(
@@ -284,6 +289,7 @@ export const batched: {
    * // timestamp=... level=INFO fiber=#0 message=two
    * // timestamp=... level=INFO fiber=#0 message=three
    * // ]
+   * ```
    *
    * @since 2.0.0
    * @category mapping
@@ -299,6 +305,7 @@ export const batched: {
    * @param window - The time window in which to batch log messages.
    *
    * @example
+   * ```ts
    * import { Console, Effect, Logger } from "effect"
    *
    * const LoggerLive = Logger.replaceScoped(
@@ -320,6 +327,7 @@ export const batched: {
    * // timestamp=... level=INFO fiber=#0 message=two
    * // timestamp=... level=INFO fiber=#0 message=three
    * // ]
+   * ```
    *
    * @since 2.0.0
    * @category mapping
@@ -342,6 +350,7 @@ export const withConsoleLog: <M, O>(self: Logger<M, O>) => Logger<M, void> = fib
  * based on the log level.
  *
  * @example
+ * ```ts
  * import { Logger, Effect } from "effect"
  *
  * const loggerLayer = Logger.replace(
@@ -353,6 +362,7 @@ export const withConsoleLog: <M, O>(self: Logger<M, O>) => Logger<M, void> = fib
  *   yield* Effect.logError("an error")
  *   yield* Effect.logInfo("an info")
  * }).pipe(Effect.provide(loggerLayer))
+ * ```
  *
  * @since 3.8.0
  * @category console
@@ -475,12 +485,14 @@ export const test: {
  * control over which log messages are displayed based on their severity.
  *
  * @example
+ * ```ts
  * import { Effect, Logger, LogLevel } from "effect"
  *
  * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
  *
  * // Effect.runFork(program)
  * // timestamp=... level=DEBUG fiber=#0 message=message1
+ * ```
  *
  * @since 2.0.0
  * @category context
@@ -491,12 +503,14 @@ export const withMinimumLogLevel: {
    * control over which log messages are displayed based on their severity.
    *
    * @example
+   * ```ts
    * import { Effect, Logger, LogLevel } from "effect"
    *
    * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
    *
    * // Effect.runFork(program)
    * // timestamp=... level=DEBUG fiber=#0 message=message1
+   * ```
    *
    * @since 2.0.0
    * @category context
@@ -507,12 +521,14 @@ export const withMinimumLogLevel: {
    * control over which log messages are displayed based on their severity.
    *
    * @example
+   * ```ts
    * import { Effect, Logger, LogLevel } from "effect"
    *
    * const program = Effect.logDebug("message1").pipe(Logger.withMinimumLogLevel(LogLevel.Debug))
    *
    * // Effect.runFork(program)
    * // timestamp=... level=DEBUG fiber=#0 message=message1
+   * ```
    *
    * @since 2.0.0
    * @category context
@@ -613,6 +629,7 @@ export const defaultLogger: Logger<unknown, void> = fiberRuntime.defaultLogger
  * integrate with logging systems that consume JSON data.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -622,6 +639,7 @@ export const defaultLogger: Logger<unknown, void> = fiberRuntime.defaultLogger
  *
  * // Effect.runFork(program.pipe(Effect.provide(Logger.json)))
  * // {"message":["message1","message2"],"logLevel":"INFO","timestamp":"...","annotations":{"key2":"value2","key1":"value1"},"spans":{"myspan":0},"fiberId":"#0"}
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -633,6 +651,7 @@ export const jsonLogger: Logger<unknown, string> = internal.jsonLogger
  * during development or in a production console.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -642,6 +661,7 @@ export const jsonLogger: Logger<unknown, string> = internal.jsonLogger
  *
  * // Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
  * // timestamp=... level=INFO fiber=#0 message=message1 message=message2 myspan=0ms key2=value2 key1=value1
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -661,6 +681,7 @@ export const stringLogger: Logger<unknown, string> = internal.stringLogger
  * development and debugging processes.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -675,6 +696,7 @@ export const stringLogger: Logger<unknown, string> = internal.stringLogger
  * //    v-- bold
  * //   key2: value2
  * //   key1: value1
+ * ```
  *
  * @since 3.5.0
  * @category constructors
@@ -702,6 +724,7 @@ export const prettyLoggerDefault: Logger<unknown, void> = internal.prettyLoggerD
  * analysis and troubleshooting.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -719,6 +742,7 @@ export const prettyLoggerDefault: Logger<unknown, void> = internal.prettyLoggerD
  * //   spans: { myspan: 0 },
  * //   fiberId: '#0'
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -747,6 +771,7 @@ export const tracerLogger: Logger<unknown, void> = fiberRuntime.tracerLogger
  * integrate with logging systems that consume JSON data.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -756,6 +781,7 @@ export const tracerLogger: Logger<unknown, void> = fiberRuntime.tracerLogger
  *
  * // Effect.runFork(program.pipe(Effect.provide(Logger.json)))
  * // {"message":["message1","message2"],"logLevel":"INFO","timestamp":"...","annotations":{"key2":"value2","key1":"value1"},"spans":{"myspan":0},"fiberId":"#0"}
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -767,6 +793,7 @@ export const json: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fibe
  * during development or in a production console.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -776,6 +803,7 @@ export const json: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fibe
  *
  * // Effect.runFork(program.pipe(Effect.provide(Logger.logFmt)))
  * // timestamp=... level=INFO fiber=#0 message=message1 message=message2 myspan=0ms key2=value2 key1=value1
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -789,6 +817,7 @@ export const logFmt: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fi
  * development and debugging processes.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -803,6 +832,7 @@ export const logFmt: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fi
  * //    v-- bold
  * //   key2: value2
  * //   key1: value1
+ * ```
  *
  * @since 3.5.0
  * @category constructors
@@ -815,6 +845,7 @@ export const pretty: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fi
  * analysis and troubleshooting.
  *
  * @example
+ * ```ts
  * import { Effect, Logger } from "effect"
  *
  * const program = Effect.log("message1", "message2").pipe(
@@ -832,6 +863,7 @@ export const pretty: Layer.Layer<never> = replace(fiberRuntime.defaultLogger, fi
  * //   spans: { myspan: 0 },
  * //   fiberId: '#0'
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -843,6 +875,7 @@ export const structured: Layer.Layer<never> = replace(fiberRuntime.defaultLogger
  * which log messages are displayed based on their severity.
  *
  * @example
+ * ```ts
  * import { Effect, Logger, LogLevel } from "effect"
  *
  * const program = Effect.gen(function*() {
@@ -854,6 +887,7 @@ export const structured: Layer.Layer<never> = replace(fiberRuntime.defaultLogger
  * // Logging disabled using a layer
  * // Effect.runFork(program.pipe(Effect.provide(Logger.minimumLogLevel(LogLevel.None))))
  * // task done
+ * ```
  *
  * @since 2.0.0
  * @category context

package/src/Mailbox.ts

@@ -178,6 +178,7 @@ export interface ReadonlyMailbox<out A, out E = never>
  * @experimental
  * @category constructors
  * @example
+ * ```ts
  * import { Effect, Mailbox } from "effect"
  *
  * Effect.gen(function*() {
@@ -202,6 +203,7 @@ export interface ReadonlyMailbox<out A, out E = never>
  *   // signal that the mailbox has failed
  *   yield* mailbox.fail("boom")
  * })
+ * ```
  */
 export const make: <A, E = never>(
   capacity?: number | {

package/src/ManagedRuntime.ts

@@ -156,6 +156,7 @@ export interface ManagedRuntimeUnifyIgnore extends Effect.EffectUnifyIgnore {
  * @since 2.0.0
  * @category runtime class
  * @example
+ * ```ts
  * import { Console, Effect, Layer, ManagedRuntime } from "effect"
  *
  * class Notifications extends Effect.Tag("Notifications")<
@@ -172,6 +173,7 @@ export interface ManagedRuntimeUnifyIgnore extends Effect.EffectUnifyIgnore {
  * }
  *
  * main()
+ * ```
  */
 export const make: <R, E>(
   layer: Layer.Layer<R, E, never>,

package/src/Metric.ts

@@ -183,6 +183,7 @@ export const mapInput: {
  * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
  *
  * @example
+ * ```ts
  * import { Metric } from "effect"
  *
  * const numberCounter = Metric.counter("count", {
@@ -193,6 +194,7 @@ export const mapInput: {
  *   description: "A bigint counter",
  *   bigint: true
  * });
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -209,6 +211,7 @@ export const counter: {
    * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
    *
    * @example
+   * ```ts
    * import { Metric } from "effect"
    *
    * const numberCounter = Metric.counter("count", {
@@ -219,6 +222,7 @@ export const counter: {
    *   description: "A bigint counter",
    *   bigint: true
    * });
+   * ```
    *
    * @since 2.0.0
    * @category constructors
@@ -242,6 +246,7 @@ export const counter: {
    * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
    *
    * @example
+   * ```ts
    * import { Metric } from "effect"
    *
    * const numberCounter = Metric.counter("count", {
@@ -252,6 +257,7 @@ export const counter: {
    *   description: "A bigint counter",
    *   bigint: true
    * });
+   * ```
    *
    * @since 2.0.0
    * @category constructors
@@ -274,11 +280,13 @@ export const counter: {
  * @param description - An optional description of the Frequency metric.
  *
  * @example
+ * ```ts
  * import { Metric } from "effect"
  *
  * const errorFrequency = Metric.frequency("error_frequency", {
  *    description: "Counts the occurrences of errors."
  * });
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -338,6 +346,7 @@ export const fromMetricKey: <Type extends MetricKeyType.MetricKeyType<any, any>>
  * - bigint - Indicates if the counter uses 'bigint' data type.
  *
  * @example
+ * ```ts
  * import { Metric } from "effect"
  *
  * const numberGauge = Metric.gauge("memory_usage", {
@@ -348,6 +357,7 @@ export const fromMetricKey: <Type extends MetricKeyType.MetricKeyType<any, any>>
  *   description: "A gauge for CPU load",
  *   bigint: true
  * });
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -363,6 +373,7 @@ export const gauge: {
    * - bigint - Indicates if the counter uses 'bigint' data type.
    *
    * @example
+   * ```ts
    * import { Metric } from "effect"
    *
    * const numberGauge = Metric.gauge("memory_usage", {
@@ -373,6 +384,7 @@ export const gauge: {
    *   description: "A gauge for CPU load",
    *   bigint: true
    * });
+   * ```
    *
    * @since 2.0.0
    * @category constructors
@@ -394,6 +406,7 @@ export const gauge: {
    * - bigint - Indicates if the counter uses 'bigint' data type.
    *
    * @example
+   * ```ts
    * import { Metric } from "effect"
    *
    * const numberGauge = Metric.gauge("memory_usage", {
@@ -404,6 +417,7 @@ export const gauge: {
    *   description: "A gauge for CPU load",
    *   bigint: true
    * });
+   * ```
    *
    * @since 2.0.0
    * @category constructors
@@ -426,12 +440,14 @@ export const gauge: {
  * @param description - A description of the histogram metric.
  *
  * @example
+ * ```ts
  * import { Metric, MetricBoundaries } from "effect"
  *
  * const latencyHistogram = Metric.histogram("latency_histogram",
  *   MetricBoundaries.linear({ start: 0, width: 10, count: 11 }),
  *   "Measures the distribution of request latency."
  * );
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -616,6 +632,7 @@ export const sync: <Out>(evaluate: LazyArg<Out>) => Metric<void, unknown, Out> =
  * - description - An optional description of the Summary metric.
  *
  * @example
+ * ```ts
  * import { Metric, Chunk } from "effect"
  *
  * const responseTimesSummary = Metric.summary({
@@ -626,6 +643,7 @@ export const sync: <Out>(evaluate: LazyArg<Out>) => Metric<void, unknown, Out> =
  *   quantiles: [0.5, 0.9, 0.99], // Calculate 50th, 90th, and 99th percentiles.
  *   description: "Measures the distribution of response times."
  * });
+ * ```
  *
  * @since 2.0.0
  * @category constructors