effect 3.13.9 → 3.13.11

package/src/Brand.ts

@@ -192,7 +192,8 @@ export const errors: (...errors: Array<Brand.BrandErrors>) => Brand.BrandErrors
  * If you don't want to perform any validation but only distinguish between two values of the same type but with different meanings,
  * see {@link nominal}.
  *
- * @example
+ * **Example**
+ *
  * ```ts
  * import * as assert from "node:assert"
  * import { Brand } from "effect"
@@ -204,7 +205,9 @@ export const errors: (...errors: Array<Brand.BrandErrors>) => Brand.BrandErrors
  *   (n) => Brand.error(`Expected ${n} to be an integer`)
  * )
  *
- * assert.strictEqual(Int(1), 1)
+ * console.log(Int(1))
+ * // 1
+ *
  * assert.throws(() => Int(1.1))
  * ```
  *
@@ -246,7 +249,8 @@ export function refined<A extends Brand<any>>(
  *
  * If you also want to perform some validation, see {@link refined}.
  *
- * @example
+ * **Example**
+ *
  * ```ts
  * import * as assert from "node:assert"
  * import { Brand } from "effect"
@@ -255,7 +259,8 @@ export function refined<A extends Brand<any>>(
  *
  * const UserId = Brand.nominal<UserId>()
  *
- * assert.strictEqual(UserId(1), 1)
+ * console.log(UserId(1))
+ * // 1
  * ```
  *
  * @since 2.0.0
@@ -277,7 +282,8 @@ export const nominal = <A extends Brand<any>>(): Brand.Constructor<
  * Combines two or more brands together to form a single branded type.
  * This API is useful when you want to validate that the input data passes multiple brand validators.
  *
- * @example
+ * **Example**
+ *
  * ```ts
  * import * as assert from "node:assert"
  * import { Brand } from "effect"
@@ -295,7 +301,9 @@ export const nominal = <A extends Brand<any>>(): Brand.Constructor<
  *
  * const PositiveInt = Brand.all(Int, Positive)
  *
- * assert.strictEqual(PositiveInt(1), 1)
+ * console.log(PositiveInt(1))
+ * // 1
+ *
  * assert.throws(() => PositiveInt(1.1))
  * ```
  *

package/src/Cause.ts

@@ -49,6 +49,7 @@ import type { Covariant, NoInfer } from "./Types.js"
  * building internal utilities that check whether an unknown value is a `Cause`.
  *
  * @see {@link isCause} Check if a value is a `Cause`
+ *
  * @since 2.0.0
  * @category Symbols
  */

package/src/Chunk.ts

@@ -360,14 +360,16 @@ const reverseChunk = <A>(self: Chunk<A>): Chunk<A> => {
  * Reverses the order of elements in a `Chunk`.
  * Importantly, if the input chunk is a `NonEmptyChunk`, the reversed chunk will also be a `NonEmptyChunk`.
  *
- * @example
+ * **Example**
+ *
  * ```ts
- * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
- * const numbers = Chunk.make(1, 2, 3)
- * const reversedNumbers = Chunk.reverse(numbers)
- * assert.deepStrictEqual(reversedNumbers, Chunk.make(3, 2, 1))
+ * const chunk = Chunk.make(1, 2, 3)
+ * const result = Chunk.reverse(chunk)
+ *
+ * console.log(result)
+ * // { _id: 'Chunk', values: [ 3, 2, 1 ] }
  * ```
  *
  * @since 2.0.0
@@ -678,15 +680,15 @@ export const dropWhile: {
  * Prepends the specified prefix chunk to the beginning of the specified chunk.
  * If either chunk is non-empty, the result is also a non-empty chunk.
  *
- * @example
+ * **Example**
+ *
  * ```ts
- * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
- * assert.deepStrictEqual(
- *   Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray),
- *   ["a", "b", 1, 2]
- * )
+ * const result = Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray)
+ *
+ * console.log(result)
+ * // [ "a", "b", 1, 2 ]
  * ```
  *
  * @category concatenating
@@ -697,15 +699,15 @@ export const prependAll: {
    * Prepends the specified prefix chunk to the beginning of the specified chunk.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   ["a", "b", 1, 2]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ "a", "b", 1, 2 ]
    * ```
    *
    * @category concatenating
@@ -716,15 +718,15 @@ export const prependAll: {
    * Prepends the specified prefix chunk to the beginning of the specified chunk.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   ["a", "b", 1, 2]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ "a", "b", 1, 2 ]
    * ```
    *
    * @category concatenating
@@ -735,15 +737,15 @@ export const prependAll: {
    * Prepends the specified prefix chunk to the beginning of the specified chunk.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   ["a", "b", 1, 2]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ "a", "b", 1, 2 ]
    * ```
    *
    * @category concatenating
@@ -754,15 +756,15 @@ export const prependAll: {
    * Prepends the specified prefix chunk to the beginning of the specified chunk.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   ["a", "b", 1, 2]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.prependAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ "a", "b", 1, 2 ]
    * ```
    *
    * @category concatenating
@@ -775,15 +777,15 @@ export const prependAll: {
  * Concatenates two chunks, combining their elements.
  * If either chunk is non-empty, the result is also a non-empty chunk.
  *
- * @example
+ * **Example**
+ *
  * ```ts
- * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
- * assert.deepStrictEqual(
- *   Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray),
- *   [1, 2, "a", "b"]
- * )
+ * const result = Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray)
+ *
+ * console.log(result)
+ * // [ 1, 2, "a", "b" ]
  * ```
  *
  * @category concatenating
@@ -794,15 +796,15 @@ export const appendAll: {
    * Concatenates two chunks, combining their elements.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   [1, 2, "a", "b"]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ 1, 2, "a", "b" ]
    * ```
    *
    * @category concatenating
@@ -813,15 +815,15 @@ export const appendAll: {
    * Concatenates two chunks, combining their elements.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   [1, 2, "a", "b"]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ 1, 2, "a", "b" ]
    * ```
    *
    * @category concatenating
@@ -832,15 +834,15 @@ export const appendAll: {
    * Concatenates two chunks, combining their elements.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   [1, 2, "a", "b"]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ 1, 2, "a", "b" ]
    * ```
    *
    * @category concatenating
@@ -851,15 +853,15 @@ export const appendAll: {
    * Concatenates two chunks, combining their elements.
    * If either chunk is non-empty, the result is also a non-empty chunk.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray),
-   *   [1, 2, "a", "b"]
-   * )
+   * const result = Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray)
+   *
+   * console.log(result)
+   * // [ 1, 2, "a", "b" ]
    * ```
    *
    * @category concatenating
@@ -879,15 +881,15 @@ export const appendAll: {
      * Concatenates two chunks, combining their elements.
      * If either chunk is non-empty, the result is also a non-empty chunk.
      *
-     * @example
+     * **Example**
+     *
      * ```ts
-     * import * as assert from "node:assert"
      * import { Chunk } from "effect"
      *
-     * assert.deepStrictEqual(
-     *   Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray),
-     *   [1, 2, "a", "b"]
-     * )
+     * const result = Chunk.make(1, 2).pipe(Chunk.appendAll(Chunk.make("a", "b")), Chunk.toArray)
+     *
+     * console.log(result)
+     * // [ 1, 2, "a", "b" ]
      * ```
      *
      * @category concatenating
@@ -1294,15 +1296,15 @@ export declare namespace Chunk {
  * Transforms the elements of a chunk using the specified mapping function.
  * If the input chunk is non-empty, the resulting chunk will also be non-empty.
  *
- * @example
+ * **Example**
+ *
  * ```ts
- * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
- * assert.deepStrictEqual(
- *   Chunk.map(Chunk.make(1, 2), (n) => n + 1),
- *   Chunk.make(2, 3)
- * )
+ * const result = Chunk.map(Chunk.make(1, 2), (n) => n + 1)
+ *
+ * console.log(result)
+ * // { _id: 'Chunk', values: [ 2, 3 ] }
  * ```
  *
  * @since 2.0.0
@@ -1313,15 +1315,15 @@ export const map: {
    * Transforms the elements of a chunk using the specified mapping function.
    * If the input chunk is non-empty, the resulting chunk will also be non-empty.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.map(Chunk.make(1, 2), (n) => n + 1),
-   *   Chunk.make(2, 3)
-   * )
+   * const result = Chunk.map(Chunk.make(1, 2), (n) => n + 1)
+   *
+   * console.log(result)
+   * // { _id: 'Chunk', values: [ 2, 3 ] }
    * ```
    *
    * @since 2.0.0
@@ -1332,15 +1334,15 @@ export const map: {
    * Transforms the elements of a chunk using the specified mapping function.
    * If the input chunk is non-empty, the resulting chunk will also be non-empty.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.map(Chunk.make(1, 2), (n) => n + 1),
-   *   Chunk.make(2, 3)
-   * )
+   * const result = Chunk.map(Chunk.make(1, 2), (n) => n + 1)
+   *
+   * console.log(result)
+   * // { _id: 'Chunk', values: [ 2, 3 ] }
    * ```
    *
    * @since 2.0.0
@@ -1351,15 +1353,15 @@ export const map: {
    * Transforms the elements of a chunk using the specified mapping function.
    * If the input chunk is non-empty, the resulting chunk will also be non-empty.
    *
-   * @example
+   * **Example**
+   *
    * ```ts
-   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
-   * assert.deepStrictEqual(
-   *   Chunk.map(Chunk.make(1, 2), (n) => n + 1),
-   *   Chunk.make(2, 3)
-   * )
+   * const result = Chunk.map(Chunk.make(1, 2), (n) => n + 1)
+   *
+   * console.log(result)
+   * // { _id: 'Chunk', values: [ 2, 3 ] }
    * ```
    *
    * @since 2.0.0

package/src/Config.ts

@@ -179,7 +179,8 @@ export const integer: (name?: string) => Config<number> = internal.integer
 /**
  * Constructs a config for a literal value.
  *
- * @example
+ * **Example**
+ *
  * ```ts
  * import { Config } from "effect"
  *

package/src/Context.ts

@@ -792,9 +792,9 @@ export const Tag: <const Id extends string>(id: Id) => <Self, Shape>() => TagCla
  * when the context is accessed, or override it with a custom implementation
  * when needed.
  *
- * @example
+ * **Example** (Declaring a Tag with a default value)
+ *
  * ```ts
- * // Title: Declaring a Tag with a default value
  * import * as assert from "node:assert"
  * import { Context, Effect } from "effect"
  *
@@ -815,9 +815,9 @@ export const Tag: <const Id extends string>(id: Id) => <Self, Shape>() => TagCla
  * // Output: The special number is 2048
  * ```
  *
- * @example
+ * **Example** (Overriding the default value)
+ *
  * ```ts
- * // Title: Overriding the default value
  * import { Context, Effect } from "effect"
  *
  * class SpecialNumber extends Context.Reference<SpecialNumber>()(