effect 3.13.8 → 3.13.9

package/src/String.ts

@@ -20,10 +20,9 @@ import * as predicate from "./Predicate.js"
 /**
  * Tests if a value is a `string`.
  *
- * @param input - The value to test.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.isString("a"), true)
@@ -84,6 +83,7 @@ export const concat: {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('a', String.toUpperCase), 'A')
@@ -96,6 +96,7 @@ export const toUpperCase = <S extends string>(self: S): Uppercase<S> => self.toU
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('A', String.toLowerCase), 'a')
@@ -108,6 +109,7 @@ export const toLowerCase = <T extends string>(self: T): Lowercase<T> => self.toL
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('abc', String.capitalize), 'Abc')
@@ -124,6 +126,7 @@ export const capitalize = <T extends string>(self: T): Capitalize<T> => {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('ABC', String.uncapitalize), 'aBC')
@@ -140,6 +143,7 @@ export const uncapitalize = <T extends string>(self: T): Uncapitalize<T> => {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('abc', String.replace('b', 'd')), 'adc')
@@ -158,6 +162,7 @@ export type Trim<A extends string> = TrimEnd<TrimStart<A>>
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.trim(' a '), 'a')
@@ -175,6 +180,7 @@ export type TrimStart<A extends string> = A extends `${" " | "\n" | "\t" | "\r"}
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.trimStart(' a '), 'a ')
@@ -192,6 +198,7 @@ export type TrimEnd<A extends string> = A extends `${infer B}${" " | "\n" | "\t"
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.trimEnd(' a '), ' a')
@@ -204,6 +211,7 @@ export const trimEnd = <A extends string>(self: A): TrimEnd<A> => self.trimEnd()
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('abcd', String.slice(1, 3)), 'bc')
@@ -218,6 +226,7 @@ export const slice = (start?: number, end?: number) => (self: string): string =>
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.isEmpty(''), true)
@@ -240,6 +249,7 @@ export const isNonEmpty = (self: string): boolean => self.length > 0
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.length('abc'), 3)
@@ -252,6 +262,7 @@ export const length = (self: string): number => self.length
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe('abc', String.split('')), ['a', 'b', 'c'])
@@ -264,6 +275,7 @@ export const split: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String } from "effect"
    *
    * assert.deepStrictEqual(pipe('abc', String.split('')), ['a', 'b', 'c'])
@@ -276,6 +288,7 @@ export const split: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String } from "effect"
    *
    * assert.deepStrictEqual(pipe('abc', String.split('')), ['a', 'b', 'c'])
@@ -314,6 +327,7 @@ export const endsWith = (searchString: string, position?: number) => (self: stri
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abc", String.charCodeAt(1)), Option.some(98))
@@ -326,6 +340,7 @@ export const charCodeAt: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.charCodeAt(1)), Option.some(98))
@@ -338,6 +353,7 @@ export const charCodeAt: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.charCodeAt(1)), Option.some(98))
@@ -356,6 +372,7 @@ export const charCodeAt: {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abcd", String.substring(1)), "bcd")
@@ -369,6 +386,7 @@ export const substring = (start: number, end?: number) => (self: string): string
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abc", String.at(1)), Option.some("b"))
@@ -381,6 +399,7 @@ export const at: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.at(1)), Option.some("b"))
@@ -393,6 +412,7 @@ export const at: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.at(1)), Option.some("b"))
@@ -407,6 +427,7 @@ export const at: {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abc", String.charAt(1)), Option.some("b"))
@@ -419,6 +440,7 @@ export const charAt: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.charAt(1)), Option.some("b"))
@@ -431,6 +453,7 @@ export const charAt: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.charAt(1)), Option.some("b"))
@@ -448,6 +471,7 @@ export const charAt: {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abc", String.codePointAt(1)), Option.some(98))
@@ -459,6 +483,7 @@ export const codePointAt: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.codePointAt(1)), Option.some(98))
@@ -470,6 +495,7 @@ export const codePointAt: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("abc", String.codePointAt(1)), Option.some(98))
@@ -483,6 +509,7 @@ export const codePointAt: {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abbbc", String.indexOf("b")), Option.some(1))
@@ -496,6 +523,7 @@ export const indexOf = (searchString: string) => (self: string): Option.Option<n
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("abbbc", String.lastIndexOf("b")), Option.some(3))
@@ -510,6 +538,7 @@ export const lastIndexOf = (searchString: string) => (self: string): Option.Opti
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe("a", String.localeCompare("b")), -1)
@@ -541,6 +570,7 @@ export const matchAll = (regexp: RegExp) => (self: string): IterableIterator<Reg
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * const str = "\u1E9B\u0323";
@@ -558,6 +588,7 @@ export const normalize = (form?: "NFC" | "NFD" | "NFKC" | "NFKD") => (self: stri
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe("a", String.padEnd(5)), "a    ")
@@ -572,6 +603,7 @@ export const padEnd = (maxLength: number, fillString?: string) => (self: string)
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe("a", String.padStart(5)), "    a")
@@ -586,6 +618,7 @@ export const padStart = (maxLength: number, fillString?: string) => (self: strin
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe("a", String.repeat(5)), "aaaaa")
@@ -598,6 +631,7 @@ export const repeat = (count: number) => (self: string): string => self.repeat(c
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * assert.deepStrictEqual(pipe("ababb", String.replaceAll("b", "c")), "acacc")
@@ -612,6 +646,7 @@ export const replaceAll = (searchValue: string | RegExp, replaceValue: string) =
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String, Option } from "effect"
  *
  * assert.deepStrictEqual(pipe("ababb", String.search("b")), Option.some(1))
@@ -625,6 +660,7 @@ export const search: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("ababb", String.search("b")), Option.some(1))
@@ -638,6 +674,7 @@ export const search: {
   /**
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, String, Option } from "effect"
    *
    * assert.deepStrictEqual(pipe("ababb", String.search("b")), Option.some(1))
@@ -657,6 +694,7 @@ export const search: {
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * const str = "\u0130"
@@ -671,6 +709,7 @@ export const toLocaleLowerCase = (locale?: string | Array<string>) => (self: str
 /**
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, String } from "effect"
  *
  * const str = "i\u0307"
@@ -694,6 +733,7 @@ export const toLocaleUpperCase = (locale?: string | Array<string>) => (self: str
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.takeLeft("Hello World", 5), "Hello")
@@ -714,6 +754,7 @@ export const takeLeft: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { String } from "effect"
    *
    * assert.deepStrictEqual(String.takeLeft("Hello World", 5), "Hello")
@@ -734,6 +775,7 @@ export const takeLeft: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { String } from "effect"
    *
    * assert.deepStrictEqual(String.takeLeft("Hello World", 5), "Hello")
@@ -756,6 +798,7 @@ export const takeLeft: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { String } from "effect"
  *
  * assert.deepStrictEqual(String.takeRight("Hello World", 5), "World")
@@ -776,6 +819,7 @@ export const takeRight: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { String } from "effect"
    *
    * assert.deepStrictEqual(String.takeRight("Hello World", 5), "World")
@@ -796,6 +840,7 @@ export const takeRight: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { String } from "effect"
    *
    * assert.deepStrictEqual(String.takeRight("Hello World", 5), "World")

package/src/Struct.ts

@@ -15,6 +15,7 @@ import type { MatchRecord, Simplify } from "./Types.js"
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, Struct } from "effect"
  *
  * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 })
@@ -29,6 +30,7 @@ export const pick: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Struct } from "effect"
    *
    * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 })
@@ -45,6 +47,7 @@ export const pick: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Struct } from "effect"
    *
    * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 })
@@ -72,6 +75,7 @@ export const pick: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, Struct } from "effect"
  *
  * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 })
@@ -86,6 +90,7 @@ export const omit: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Struct } from "effect"
    *
    * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 })
@@ -100,6 +105,7 @@ export const omit: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Struct } from "effect"
    *
    * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 })
@@ -128,6 +134,7 @@ export const omit: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Struct, String, Number } from "effect"
  *
  * const PersonEquivalence = Struct.getEquivalence({
@@ -181,6 +188,7 @@ type PartialTransform<O, T> = {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, Struct } from "effect"
  *
  * assert.deepStrictEqual(
@@ -204,6 +212,7 @@ export const evolve: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Struct } from "effect"
    *
    * assert.deepStrictEqual(
@@ -227,6 +236,7 @@ export const evolve: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { pipe, Struct } from "effect"
    *
    * assert.deepStrictEqual(
@@ -263,6 +273,7 @@ export const evolve: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { pipe, Struct } from "effect"
  *
  * const value = pipe({ a: 1, b: 2 }, Struct.get("a"))
@@ -281,6 +292,7 @@ export const get =
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Struct } from "effect"
  *
  * const symbol: unique symbol = Symbol()

package/src/Symbol.ts

@@ -8,10 +8,9 @@ import * as predicate from "./Predicate.js"
 /**
  * Tests if a value is a `symbol`.
  *
- * @param input - The value to test.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Predicate } from "effect"
  *
  * assert.deepStrictEqual(Predicate.isSymbol(Symbol.for("a")), true)

package/src/TestClock.ts

@@ -47,7 +47,8 @@ import * as Live from "./TestLive.js"
  * For example, here is how we can test `Effect.timeout` using `TestClock`:
  *
  * ```ts
- * import { Duration, Effect, Fiber, TestClock, Option } from "effect"
+ * import * as assert from "node:assert"
+ * import { Duration, Effect, Fiber, TestClock, Option, pipe } from "effect"
  *
  * Effect.gen(function*() {
  *   const fiber = yield* pipe(