effect 4.0.0-beta.102 → 4.0.0-beta.104

package/dist/String.d.ts

@@ -39,12 +39,11 @@ export declare const String: StringConstructor;
  *
  * **Example** (Checking for strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.isString("a"), true)
- * assert.deepStrictEqual(String.isString(1), false)
+ * String.isString("a") // => true
+ * String.isString(1) // => false
  * ```
  *
  * @category guards
@@ -57,12 +56,12 @@ export declare const isString: Refinement<unknown, string>;
  *
  * **Example** (Comparing strings lexicographically)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.Order("apple", "banana")) // -1
- * console.log(String.Order("banana", "apple")) // 1
- * console.log(String.Order("apple", "apple")) // 0
+ * String.Order("apple", "banana") // => -1
+ * String.Order("banana", "apple") // => 1
+ * String.Order("apple", "apple") // => 0
  * ```
  *
  * @category instances
@@ -74,11 +73,11 @@ export declare const Order: order.Order<string>;
  *
  * **Example** (Comparing strings for equality)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.Equivalence("hello", "hello")) // true
- * console.log(String.Equivalence("hello", "world")) // false
+ * String.Equivalence("hello", "hello") // => true
+ * String.Equivalence("hello", "world") // => false
  * ```
  *
  * @category instances
@@ -94,11 +93,11 @@ export declare const Equivalence: Equ.Equivalence<string>;
  *
  * **Example** (Referencing the empty string)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.empty) // ""
- * console.log(String.isEmpty(String.empty)) // true
+ * String.empty // => ""
+ * String.isEmpty(String.empty) // => true
  * ```
  *
  * @category constants
@@ -110,11 +109,13 @@ export declare const empty: "";
  *
  * **Example** (Concatenating string literal types)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import type { String } from "effect"
  *
  * // Type-level concatenation
  * type Result = String.Concat<"hello", "world"> // "helloworld"
+ *
+ * const witness: Result = "helloworld"
  * ```
  *
  * @category models
@@ -126,14 +127,11 @@ export type Concat<A extends string, B extends string> = `${A}${B}`;
  *
  * **Example** (Concatenating strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
  *
- * const result1 = String.concat("hello", "world")
- * console.log(result1) // "helloworld"
- *
- * const result2 = pipe("hello", String.concat("world"))
- * console.log(result2) // "helloworld"
+ * String.concat("hello", "world") // => "helloworld"
+ * pipe("hello", String.concat("world")) // => "helloworld"
  * ```
  *
  * @category combining
@@ -145,14 +143,11 @@ export declare const concat: {
      *
      * **Example** (Concatenating strings)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { pipe, String } from "effect"
      *
-     * const result1 = String.concat("hello", "world")
-     * console.log(result1) // "helloworld"
-     *
-     * const result2 = pipe("hello", String.concat("world"))
-     * console.log(result2) // "helloworld"
+     * String.concat("hello", "world") // => "helloworld"
+     * pipe("hello", String.concat("world")) // => "helloworld"
      * ```
      *
      * @category combining
@@ -164,14 +159,11 @@ export declare const concat: {
      *
      * **Example** (Concatenating strings)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { pipe, String } from "effect"
      *
-     * const result1 = String.concat("hello", "world")
-     * console.log(result1) // "helloworld"
-     *
-     * const result2 = pipe("hello", String.concat("world"))
-     * console.log(result2) // "helloworld"
+     * String.concat("hello", "world") // => "helloworld"
+     * pipe("hello", String.concat("world")) // => "helloworld"
      * ```
      *
      * @category combining
@@ -184,12 +176,11 @@ export declare const concat: {
  *
  * **Example** (Converting strings to uppercase)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("a", String.toUpperCase), "A")
- * assert.deepStrictEqual(String.toUpperCase("hello"), "HELLO")
+ * pipe("a", String.toUpperCase) // => "A"
+ * String.toUpperCase("hello") // => "HELLO"
  * ```
  *
  * @category transforming
@@ -201,12 +192,11 @@ export declare const toUpperCase: <S extends string>(self: S) => Uppercase<S>;
  *
  * **Example** (Converting strings to lowercase)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("A", String.toLowerCase), "a")
- * assert.deepStrictEqual(String.toLowerCase("HELLO"), "hello")
+ * pipe("A", String.toLowerCase) // => "a"
+ * String.toLowerCase("HELLO") // => "hello"
  * ```
  *
  * @category transforming
@@ -218,12 +208,11 @@ export declare const toLowerCase: <T extends string>(self: T) => Lowercase<T>;
  *
  * **Example** (Capitalizing a string)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("abc", String.capitalize), "Abc")
- * assert.deepStrictEqual(String.capitalize("hello"), "Hello")
+ * pipe("abc", String.capitalize) // => "Abc"
+ * String.capitalize("hello") // => "Hello"
  * ```
  *
  * @category transforming
@@ -235,12 +224,11 @@ export declare const capitalize: <T extends string>(self: T) => Capitalize<T>;
  *
  * **Example** (Uncapitalizing a string)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("ABC", String.uncapitalize), "aBC")
- * assert.deepStrictEqual(String.uncapitalize("Hello"), "hello")
+ * pipe("ABC", String.uncapitalize) // => "aBC"
+ * String.uncapitalize("Hello") // => "hello"
  * ```
  *
  * @category transforming
@@ -257,15 +245,11 @@ export declare const uncapitalize: <T extends string>(self: T) => Uncapitalize<T
  *
  * **Example** (Replacing a substring)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("abc", String.replace("b", "d")), "adc")
- * assert.deepStrictEqual(
- *   pipe("hello world", String.replace("world", "Effect")),
- *   "hello Effect"
- * )
+ * pipe("abc", String.replace("b", "d")) // => "adc"
+ * pipe("hello world", String.replace("world", "Effect")) // => "hello Effect"
  * ```
  *
  * @category transforming
@@ -277,10 +261,12 @@ export declare const replace: (searchValue: string | RegExp, replaceValue: strin
  *
  * **Example** (Trimming whitespace at the type level)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import type { String } from "effect"
  *
  * type Result = String.Trim<"  hello  "> // "hello"
+ *
+ * const witness: Result = "hello"
  * ```
  *
  * @category models
@@ -292,12 +278,11 @@ export type Trim<A extends string> = TrimEnd<TrimStart<A>>;
  *
  * **Example** (Trimming whitespace)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.trim(" a "), "a")
- * assert.deepStrictEqual(String.trim("  hello world  "), "hello world")
+ * String.trim(" a ") // => "a"
+ * String.trim("  hello world  ") // => "hello world"
  * ```
  *
  * @category transforming
@@ -309,10 +294,12 @@ export declare const trim: <A extends string>(self: A) => Trim<A>;
  *
  * **Example** (Trimming leading whitespace at the type level)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import type { String } from "effect"
  *
  * type Result = String.TrimStart<"  hello"> // "hello"
+ *
+ * const witness: Result = "hello"
  * ```
  *
  * @category models
@@ -324,12 +311,11 @@ export type TrimStart<A extends string> = A extends `${" " | "\n" | "\t" | "\r"}
  *
  * **Example** (Trimming leading whitespace)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.trimStart(" a "), "a ")
- * assert.deepStrictEqual(String.trimStart("  hello world"), "hello world")
+ * String.trimStart(" a ") // => "a "
+ * String.trimStart("  hello world") // => "hello world"
  * ```
  *
  * @category transforming
@@ -341,10 +327,12 @@ export declare const trimStart: <A extends string>(self: A) => TrimStart<A>;
  *
  * **Example** (Trimming trailing whitespace at the type level)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import type { String } from "effect"
  *
  * type Result = String.TrimEnd<"hello  "> // "hello"
+ *
+ * const witness: Result = "hello"
  * ```
  *
  * @category models
@@ -356,12 +344,11 @@ export type TrimEnd<A extends string> = A extends `${infer B}${" " | "\n" | "\t"
  *
  * **Example** (Trimming trailing whitespace)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.trimEnd(" a "), " a")
- * assert.deepStrictEqual(String.trimEnd("hello world  "), "hello world")
+ * String.trimEnd(" a ") // => " a"
+ * String.trimEnd("hello world  ") // => "hello world"
  * ```
  *
  * @category transforming
@@ -373,12 +360,11 @@ export declare const trimEnd: <A extends string>(self: A) => TrimEnd<A>;
  *
  * **Example** (Slicing strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("abcd", String.slice(1, 3)), "bc")
- * assert.deepStrictEqual(pipe("hello world", String.slice(0, 5)), "hello")
+ * pipe("abcd", String.slice(1, 3)) // => "bc"
+ * pipe("hello world", String.slice(0, 5)) // => "hello"
  * ```
  *
  * @category transforming
@@ -390,15 +376,14 @@ export declare const slice: (start?: number, end?: number) => (self: string) =>
  *
  * **Example** (Checking for empty strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.isEmpty(""), true)
- * assert.deepStrictEqual(String.isEmpty("a"), false)
+ * String.isEmpty("") // => true
+ * String.isEmpty("a") // => false
  * ```
  *
- * @category predicates
+ * @category guards
  * @since 2.0.0
  */
 export declare const isEmpty: (self: string) => self is "";
@@ -407,15 +392,14 @@ export declare const isEmpty: (self: string) => self is "";
  *
  * **Example** (Checking for non-empty strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.isNonEmpty(""), false)
- * assert.deepStrictEqual(String.isNonEmpty("a"), true)
+ * String.isNonEmpty("") // => false
+ * String.isNonEmpty("a") // => true
  * ```
  *
- * @category guards
+ * @category predicates
  * @since 2.0.0
  */
 export declare const isNonEmpty: (self: string) => boolean;
@@ -424,11 +408,10 @@ export declare const isNonEmpty: (self: string) => boolean;
  *
  * **Example** (Getting string length)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.length("abc"), 3)
+ * String.length("abc") // => 3
  * ```
  *
  * @category getters
@@ -440,13 +423,12 @@ export declare const length: (self: string) => number;
  *
  * **Example** (Splitting strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("abc", String.split("")), ["a", "b", "c"])
- * assert.deepStrictEqual(pipe("", String.split("")), [""])
- * assert.deepStrictEqual(String.split("hello,world", ","), ["hello", "world"])
+ * pipe("abc", String.split("")) // => ["a", "b", "c"]
+ * pipe("", String.split("")) // => [""]
+ * String.split("hello,world", ",") // => ["hello", "world"]
  * ```
  *
  * @category transforming
@@ -458,13 +440,12 @@ export declare const split: {
      *
      * **Example** (Splitting strings)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { pipe, String } from "effect"
-     * import * as assert from "node:assert"
      *
-     * assert.deepStrictEqual(pipe("abc", String.split("")), ["a", "b", "c"])
-     * assert.deepStrictEqual(pipe("", String.split("")), [""])
-     * assert.deepStrictEqual(String.split("hello,world", ","), ["hello", "world"])
+     * pipe("abc", String.split("")) // => ["a", "b", "c"]
+     * pipe("", String.split("")) // => [""]
+     * String.split("hello,world", ",") // => ["hello", "world"]
      * ```
      *
      * @category transforming
@@ -476,13 +457,12 @@ export declare const split: {
      *
      * **Example** (Splitting strings)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { pipe, String } from "effect"
-     * import * as assert from "node:assert"
      *
-     * assert.deepStrictEqual(pipe("abc", String.split("")), ["a", "b", "c"])
-     * assert.deepStrictEqual(pipe("", String.split("")), [""])
-     * assert.deepStrictEqual(String.split("hello,world", ","), ["hello", "world"])
+     * pipe("abc", String.split("")) // => ["a", "b", "c"]
+     * pipe("", String.split("")) // => [""]
+     * String.split("hello,world", ",") // => ["hello", "world"]
      * ```
      *
      * @category transforming
@@ -496,12 +476,11 @@ export declare const split: {
  *
  * **Example** (Checking for substrings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("hello world", String.includes("world")), true)
- * assert.deepStrictEqual(pipe("hello world", String.includes("foo")), false)
+ * pipe("hello world", String.includes("world")) // => true
+ * pipe("hello world", String.includes("foo")) // => false
  * ```
  *
  * @category predicates
@@ -513,12 +492,11 @@ export declare const includes: (searchString: string, position?: number) => (sel
  *
  * **Example** (Checking string prefixes)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("hello world", String.startsWith("hello")), true)
- * assert.deepStrictEqual(pipe("hello world", String.startsWith("world")), false)
+ * pipe("hello world", String.startsWith("hello")) // => true
+ * pipe("hello world", String.startsWith("world")) // => false
  * ```
  *
  * @category predicates
@@ -530,12 +508,11 @@ export declare const startsWith: (searchString: string, position?: number) => (s
  *
  * **Example** (Checking string suffixes)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("hello world", String.endsWith("world")), true)
- * assert.deepStrictEqual(pipe("hello world", String.endsWith("hello")), false)
+ * pipe("hello world", String.endsWith("world")) // => true
+ * pipe("hello world", String.endsWith("hello")) // => false
  * ```
  *
  * @category predicates
@@ -547,14 +524,14 @@ export declare const endsWith: (searchString: string, position?: number) => (sel
  *
  * **Example** (Reading character codes)
  *
- * ```ts
- * import { String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, String } from "effect"
  *
- * String.charCodeAt("abc", 1) // Option.some(98)
- * String.charCodeAt("abc", 4) // Option.none()
+ * String.charCodeAt("abc", 1) // => Option.some(98)
+ * String.charCodeAt("abc", 4) // => Option.none()
  * ```
  *
- * @category elements
+ * @category getters
  * @since 2.0.0
  */
 export declare const charCodeAt: {
@@ -563,14 +540,14 @@ export declare const charCodeAt: {
      *
      * **Example** (Reading character codes)
      *
-     * ```ts
-     * import { String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, String } from "effect"
      *
-     * String.charCodeAt("abc", 1) // Option.some(98)
-     * String.charCodeAt("abc", 4) // Option.none()
+     * String.charCodeAt("abc", 1) // => Option.some(98)
+     * String.charCodeAt("abc", 4) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (index: number): (self: string) => Option.Option<number>;
@@ -579,14 +556,14 @@ export declare const charCodeAt: {
      *
      * **Example** (Reading character codes)
      *
-     * ```ts
-     * import { String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, String } from "effect"
      *
-     * String.charCodeAt("abc", 1) // Option.some(98)
-     * String.charCodeAt("abc", 4) // Option.none()
+     * String.charCodeAt("abc", 1) // => Option.some(98)
+     * String.charCodeAt("abc", 4) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (self: string, index: number): Option.Option<number>;
@@ -596,11 +573,11 @@ export declare const charCodeAt: {
  *
  * **Example** (Extracting substrings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
  *
- * pipe("abcd", String.substring(1)) // "bcd"
- * pipe("abcd", String.substring(1, 3)) // "bc"
+ * pipe("abcd", String.substring(1)) // => "bcd"
+ * pipe("abcd", String.substring(1, 3)) // => "bc"
  * ```
  *
  * @category transforming
@@ -612,14 +589,14 @@ export declare const substring: (start: number, end?: number) => (self: string)
  *
  * **Example** (Accessing characters safely)
  *
- * ```ts
- * import { pipe, String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, pipe, String } from "effect"
  *
- * pipe("abc", String.at(1)) // Option.some("b")
- * pipe("abc", String.at(4)) // Option.none()
+ * pipe("abc", String.at(1)) // => Option.some("b")
+ * pipe("abc", String.at(4)) // => Option.none()
  * ```
  *
- * @category elements
+ * @category getters
  * @since 2.0.0
  */
 export declare const at: {
@@ -628,14 +605,14 @@ export declare const at: {
      *
      * **Example** (Accessing characters safely)
      *
-     * ```ts
-     * import { pipe, String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, pipe, String } from "effect"
      *
-     * pipe("abc", String.at(1)) // Option.some("b")
-     * pipe("abc", String.at(4)) // Option.none()
+     * pipe("abc", String.at(1)) // => Option.some("b")
+     * pipe("abc", String.at(4)) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (index: number): (self: string) => Option.Option<string>;
@@ -644,14 +621,14 @@ export declare const at: {
      *
      * **Example** (Accessing characters safely)
      *
-     * ```ts
-     * import { pipe, String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, pipe, String } from "effect"
      *
-     * pipe("abc", String.at(1)) // Option.some("b")
-     * pipe("abc", String.at(4)) // Option.none()
+     * pipe("abc", String.at(1)) // => Option.some("b")
+     * pipe("abc", String.at(4)) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (self: string, index: number): Option.Option<string>;
@@ -661,14 +638,14 @@ export declare const at: {
  *
  * **Example** (Reading characters safely)
  *
- * ```ts
- * import { pipe, String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, pipe, String } from "effect"
  *
- * pipe("abc", String.charAt(1)) // Option.some("b")
- * pipe("abc", String.charAt(4)) // Option.none()
+ * pipe("abc", String.charAt(1)) // => Option.some("b")
+ * pipe("abc", String.charAt(4)) // => Option.none()
  * ```
  *
- * @category elements
+ * @category getters
  * @since 2.0.0
  */
 export declare const charAt: {
@@ -677,14 +654,14 @@ export declare const charAt: {
      *
      * **Example** (Reading characters safely)
      *
-     * ```ts
-     * import { pipe, String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, pipe, String } from "effect"
      *
-     * pipe("abc", String.charAt(1)) // Option.some("b")
-     * pipe("abc", String.charAt(4)) // Option.none()
+     * pipe("abc", String.charAt(1)) // => Option.some("b")
+     * pipe("abc", String.charAt(4)) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (index: number): (self: string) => Option.Option<string>;
@@ -693,14 +670,14 @@ export declare const charAt: {
      *
      * **Example** (Reading characters safely)
      *
-     * ```ts
-     * import { pipe, String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, pipe, String } from "effect"
      *
-     * pipe("abc", String.charAt(1)) // Option.some("b")
-     * pipe("abc", String.charAt(4)) // Option.none()
+     * pipe("abc", String.charAt(1)) // => Option.some("b")
+     * pipe("abc", String.charAt(4)) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (self: string, index: number): Option.Option<string>;
@@ -710,14 +687,14 @@ export declare const charAt: {
  *
  * **Example** (Reading code points)
  *
- * ```ts
- * import { pipe, String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, pipe, String } from "effect"
  *
- * pipe("abc", String.codePointAt(1)) // Option.some(98)
- * pipe("abc", String.codePointAt(10)) // Option.none()
+ * pipe("abc", String.codePointAt(1)) // => Option.some(98)
+ * pipe("abc", String.codePointAt(10)) // => Option.none()
  * ```
  *
- * @category elements
+ * @category getters
  * @since 2.0.0
  */
 export declare const codePointAt: {
@@ -726,14 +703,14 @@ export declare const codePointAt: {
      *
      * **Example** (Reading code points)
      *
-     * ```ts
-     * import { pipe, String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, pipe, String } from "effect"
      *
-     * pipe("abc", String.codePointAt(1)) // Option.some(98)
-     * pipe("abc", String.codePointAt(10)) // Option.none()
+     * pipe("abc", String.codePointAt(1)) // => Option.some(98)
+     * pipe("abc", String.codePointAt(10)) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (index: number): (self: string) => Option.Option<number>;
@@ -742,14 +719,14 @@ export declare const codePointAt: {
      *
      * **Example** (Reading code points)
      *
-     * ```ts
-     * import { pipe, String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, pipe, String } from "effect"
      *
-     * pipe("abc", String.codePointAt(1)) // Option.some(98)
-     * pipe("abc", String.codePointAt(10)) // Option.none()
+     * pipe("abc", String.codePointAt(1)) // => Option.some(98)
+     * pipe("abc", String.codePointAt(10)) // => Option.none()
      * ```
      *
-     * @category elements
+     * @category getters
      * @since 2.0.0
      */
     (self: string, index: number): Option.Option<number>;
@@ -759,11 +736,11 @@ export declare const codePointAt: {
  *
  * **Example** (Finding the first substring index)
  *
- * ```ts
- * import { pipe, String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, pipe, String } from "effect"
  *
- * pipe("abbbc", String.indexOf("b")) // Option.some(1)
- * pipe("abbbc", String.indexOf("z")) // Option.none()
+ * pipe("abbbc", String.indexOf("b")) // => Option.some(1)
+ * pipe("abbbc", String.indexOf("z")) // => Option.none()
  * ```
  *
  * @category searching
@@ -775,11 +752,11 @@ export declare const indexOf: (searchString: string) => (self: string) => Option
  *
  * **Example** (Finding the last substring index)
  *
- * ```ts
- * import { pipe, String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, pipe, String } from "effect"
  *
- * pipe("abbbc", String.lastIndexOf("b")) // Option.some(3)
- * pipe("abbbc", String.lastIndexOf("d")) // Option.none()
+ * pipe("abbbc", String.lastIndexOf("b")) // => Option.some(3)
+ * pipe("abbbc", String.lastIndexOf("d")) // => Option.none()
  * ```
  *
  * @category searching
@@ -793,16 +770,15 @@ export declare const lastIndexOf: (searchString: string) => (self: string) => Op
  *
  * **Example** (Comparing strings by locale)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("a", String.localeCompare("b")), -1)
- * assert.deepStrictEqual(pipe("b", String.localeCompare("a")), 1)
- * assert.deepStrictEqual(pipe("a", String.localeCompare("a")), 0)
+ * pipe("a", String.localeCompare("b")) // => -1
+ * pipe("b", String.localeCompare("a")) // => 1
+ * pipe("a", String.localeCompare("a")) // => 0
  * ```
  *
- * @category comparing
+ * @category comparisons
  * @since 2.0.0
  */
 export declare const localeCompare: (that: string, locales?: Array<string>, options?: Intl.CollatorOptions) => (self: string) => Ordering.Ordering;
@@ -812,16 +788,15 @@ export declare const localeCompare: (that: string, locales?: Array<string>, opti
  *
  * **Example** (Matching regular expressions)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Option, pipe, String } from "effect"
  *
- * const match = pipe("hello", String.match(/l+/))
- *
- * if (Option.isSome(match)) {
- *   console.log(`${match.value[0]}@${match.value.index}`) // "ll@2"
- * }
- *
- * console.log(Option.isNone(pipe("hello", String.match(/x/)))) // true
+ * pipe(
+ *   "hello",
+ *   String.match(/l+/),
+ *   Option.map((match) => [match[0], match.index])
+ * ) // => Option.some(["ll", 2])
+ * pipe("hello", String.match(/x/)) // => Option.none()
  * ```
  *
  * @category searching
@@ -834,13 +809,12 @@ export declare const match: (regExp: RegExp | string) => (self: string) => Optio
  *
  * **Example** (Iterating regular expression matches)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
  *
  * const matches = pipe("hello world", String.matchAll(/l/g))
- * console.log(
- *   Array.from(matches, (match) => `${match[0]}@${match.index}`).join(", ")
- * ) // "l@2, l@3, l@9"
+ *
+ * Array.from(matches, (match) => [match[0], match.index]) // => [["l", 2], ["l", 3], ["l", 9]]
  * ```
  *
  * @category searching
@@ -852,19 +826,21 @@ export declare const matchAll: (regExp: RegExp) => (self: string) => IterableIte
  *
  * **Example** (Normalizing Unicode strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
  * const str = "\u1E9B\u0323"
- * assert.deepStrictEqual(pipe(str, String.normalize()), "\u1E9B\u0323")
- * assert.deepStrictEqual(pipe(str, String.normalize("NFC")), "\u1E9B\u0323")
- * assert.deepStrictEqual(pipe(str, String.normalize("NFD")), "\u017F\u0323\u0307")
- * assert.deepStrictEqual(pipe(str, String.normalize("NFKC")), "\u1E69")
- * assert.deepStrictEqual(
+ * Array.from(pipe(str, String.normalize()), (character) => character.codePointAt(0)) // => [0x1e9b, 0x323]
+ * Array.from(pipe(str, String.normalize("NFC")), (character) => character.codePointAt(0)) // => [0x1e9b, 0x323]
+ * Array.from(
+ *   pipe(str, String.normalize("NFD")),
+ *   (character) => character.codePointAt(0)
+ * ) // => [0x17f, 0x323, 0x307]
+ * Array.from(pipe(str, String.normalize("NFKC")), (character) => character.codePointAt(0)) // => [0x1e69]
+ * Array.from(
  *   pipe(str, String.normalize("NFKD")),
- *   "\u0073\u0323\u0307"
- * )
+ *   (character) => character.codePointAt(0)
+ * ) // => [0x73, 0x323, 0x307]
  * ```
  *
  * @category transforming
@@ -876,12 +852,11 @@ export declare const normalize: (form?: "NFC" | "NFD" | "NFKC" | "NFKD") => (sel
  *
  * **Example** (Padding strings at the end)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("a", String.padEnd(5)), "a    ")
- * assert.deepStrictEqual(pipe("a", String.padEnd(5, "_")), "a____")
+ * pipe("a", String.padEnd(5)) // => "a    "
+ * pipe("a", String.padEnd(5, "_")) // => "a____"
  * ```
  *
  * @category transforming
@@ -893,12 +868,11 @@ export declare const padEnd: (maxLength: number, fillString?: string) => (self:
  *
  * **Example** (Padding strings at the start)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("a", String.padStart(5)), "    a")
- * assert.deepStrictEqual(pipe("a", String.padStart(5, "_")), "____a")
+ * pipe("a", String.padStart(5)) // => "    a"
+ * pipe("a", String.padStart(5, "_")) // => "____a"
  * ```
  *
  * @category transforming
@@ -910,12 +884,11 @@ export declare const padStart: (maxLength: number, fillString?: string) => (self
  *
  * **Example** (Repeating strings)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("a", String.repeat(5)), "aaaaa")
- * assert.deepStrictEqual(pipe("hello", String.repeat(3)), "hellohellohello")
+ * pipe("a", String.repeat(5)) // => "aaaaa"
+ * pipe("hello", String.repeat(3)) // => "hellohellohello"
  * ```
  *
  * @category transforming
@@ -927,12 +900,11 @@ export declare const repeat: (count: number) => (self: string) => string;
  *
  * **Example** (Replacing all matches)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(pipe("ababb", String.replaceAll("b", "c")), "acacc")
- * assert.deepStrictEqual(pipe("ababb", String.replaceAll(/ba/g, "cc")), "accbb")
+ * pipe("ababb", String.replaceAll("b", "c")) // => "acacc"
+ * pipe("ababb", String.replaceAll(/ba/g, "cc")) // => "accbb"
  * ```
  *
  * @category transforming
@@ -945,12 +917,12 @@ export declare const replaceAll: (searchValue: string | RegExp, replaceValue: st
  *
  * **Example** (Searching strings)
  *
- * ```ts
- * import { String } from "effect"
+ * ```ts import.meta.vitest
+ * import { Option, String } from "effect"
  *
- * String.search("ababb", "b") // Option.some(1)
- * String.search("ababb", /abb/) // Option.some(2)
- * String.search("ababb", "d") // Option.none()
+ * String.search("ababb", "b") // => Option.some(1)
+ * String.search("ababb", /abb/) // => Option.some(2)
+ * String.search("ababb", "d") // => Option.none()
  * ```
  *
  * @category searching
@@ -963,12 +935,12 @@ export declare const search: {
      *
      * **Example** (Searching strings)
      *
-     * ```ts
-     * import { String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, String } from "effect"
      *
-     * String.search("ababb", "b") // Option.some(1)
-     * String.search("ababb", /abb/) // Option.some(2)
-     * String.search("ababb", "d") // Option.none()
+     * String.search("ababb", "b") // => Option.some(1)
+     * String.search("ababb", /abb/) // => Option.some(2)
+     * String.search("ababb", "d") // => Option.none()
      * ```
      *
      * @category searching
@@ -981,12 +953,12 @@ export declare const search: {
      *
      * **Example** (Searching strings)
      *
-     * ```ts
-     * import { String } from "effect"
+     * ```ts import.meta.vitest
+     * import { Option, String } from "effect"
      *
-     * String.search("ababb", "b") // Option.some(1)
-     * String.search("ababb", /abb/) // Option.some(2)
-     * String.search("ababb", "d") // Option.none()
+     * String.search("ababb", "b") // => Option.some(1)
+     * String.search("ababb", /abb/) // => Option.some(2)
+     * String.search("ababb", "d") // => Option.none()
      * ```
      *
      * @category searching
@@ -999,12 +971,11 @@ export declare const search: {
  *
  * **Example** (Lowercasing strings by locale)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
  * const str = "\u0130"
- * assert.deepStrictEqual(pipe(str, String.toLocaleLowerCase("tr")), "i")
+ * pipe(str, String.toLocaleLowerCase("tr")) // => "i"
  * ```
  *
  * @category transforming
@@ -1016,12 +987,11 @@ export declare const toLocaleLowerCase: (locale?: string | Array<string>) => (se
  *
  * **Example** (Uppercasing strings by locale)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { pipe, String } from "effect"
- * import * as assert from "node:assert"
  *
  * const str = "i\u0307"
- * assert.deepStrictEqual(pipe(str, String.toLocaleUpperCase("lt-LT")), "I")
+ * pipe(str, String.toLocaleUpperCase("lt-LT")) // => "I"
  * ```
  *
  * @category transforming
@@ -1042,11 +1012,10 @@ export declare const toLocaleUpperCase: (locale?: string | Array<string>) => (se
  *
  * **Example** (Taking characters from the start)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.takeLeft("Hello World", 5), "Hello")
+ * String.takeLeft("Hello World", 5) // => "Hello"
  * ```
  *
  * @category transforming
@@ -1067,11 +1036,10 @@ export declare const takeLeft: {
      *
      * **Example** (Taking characters from the start)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { String } from "effect"
-     * import * as assert from "node:assert"
      *
-     * assert.deepStrictEqual(String.takeLeft("Hello World", 5), "Hello")
+     * String.takeLeft("Hello World", 5) // => "Hello"
      * ```
      *
      * @category transforming
@@ -1092,11 +1060,10 @@ export declare const takeLeft: {
      *
      * **Example** (Taking characters from the start)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { String } from "effect"
-     * import * as assert from "node:assert"
      *
-     * assert.deepStrictEqual(String.takeLeft("Hello World", 5), "Hello")
+     * String.takeLeft("Hello World", 5) // => "Hello"
      * ```
      *
      * @category transforming
@@ -1118,11 +1085,10 @@ export declare const takeLeft: {
  *
  * **Example** (Taking characters from the end)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
- * import * as assert from "node:assert"
  *
- * assert.deepStrictEqual(String.takeRight("Hello World", 5), "World")
+ * String.takeRight("Hello World", 5) // => "World"
  * ```
  *
  * @category transforming
@@ -1143,11 +1109,10 @@ export declare const takeRight: {
      *
      * **Example** (Taking characters from the end)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { String } from "effect"
-     * import * as assert from "node:assert"
      *
-     * assert.deepStrictEqual(String.takeRight("Hello World", 5), "World")
+     * String.takeRight("Hello World", 5) // => "World"
      * ```
      *
      * @category transforming
@@ -1168,11 +1133,10 @@ export declare const takeRight: {
      *
      * **Example** (Taking characters from the end)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { String } from "effect"
-     * import * as assert from "node:assert"
      *
-     * assert.deepStrictEqual(String.takeRight("Hello World", 5), "World")
+     * String.takeRight("Hello World", 5) // => "World"
      * ```
      *
      * @category transforming
@@ -1186,11 +1150,10 @@ export declare const takeRight: {
  *
  * **Example** (Iterating lines without separators)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * const lines = String.linesIterator("hello\nworld\n")
- * console.log(Array.from(lines)) // ["hello", "world"]
+ * Array.from(String.linesIterator("hello\nworld\n")) // => ["hello", "world"]
  * ```
  *
  * @category splitting
@@ -1203,11 +1166,10 @@ export declare const linesIterator: (self: string) => LinesIterator;
  *
  * **Example** (Iterating lines with separators)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * const lines = String.linesWithSeparators("hello\nworld\n")
- * console.log(Array.from(lines)) // ["hello\n", "world\n"]
+ * Array.from(String.linesWithSeparators("hello\nworld\n")) // => ["hello\n", "world\n"]
  * ```
  *
  * @category splitting
@@ -1220,12 +1182,10 @@ export declare const linesWithSeparators: (s: string) => LinesIterator;
  *
  * **Example** (Stripping custom margins)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * const text = "  |hello\n  |world"
- * const result = String.stripMarginWith(text, "|")
- * console.log(result) // "hello\nworld"
+ * String.stripMarginWith("  |hello\n  |world", "|") // => "hello\nworld"
  * ```
  *
  * @category transforming
@@ -1238,12 +1198,10 @@ export declare const stripMarginWith: {
      *
      * **Example** (Stripping custom margins)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { String } from "effect"
      *
-     * const text = "  |hello\n  |world"
-     * const result = String.stripMarginWith(text, "|")
-     * console.log(result) // "hello\nworld"
+     * String.stripMarginWith("  |hello\n  |world", "|") // => "hello\nworld"
      * ```
      *
      * @category transforming
@@ -1256,12 +1214,10 @@ export declare const stripMarginWith: {
      *
      * **Example** (Stripping custom margins)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { String } from "effect"
      *
-     * const text = "  |hello\n  |world"
-     * const result = String.stripMarginWith(text, "|")
-     * console.log(result) // "hello\nworld"
+     * String.stripMarginWith("  |hello\n  |world", "|") // => "hello\nworld"
      * ```
      *
      * @category transforming
@@ -1274,12 +1230,10 @@ export declare const stripMarginWith: {
  *
  * **Example** (Stripping pipe margins)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * const text = "  |hello\n  |world"
- * const result = String.stripMargin(text)
- * console.log(result) // "hello\nworld"
+ * String.stripMargin("  |hello\n  |world") // => "hello\nworld"
  * ```
  *
  * @category transforming
@@ -1291,11 +1245,11 @@ export declare const stripMargin: (self: string) => string;
  *
  * **Example** (Converting snake_case to camelCase)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.snakeToCamel("hello_world")) // "helloWorld"
- * console.log(String.snakeToCamel("foo_bar_baz")) // "fooBarBaz"
+ * String.snakeToCamel("hello_world") // => "helloWorld"
+ * String.snakeToCamel("foo_bar_baz") // => "fooBarBaz"
  * ```
  *
  * @category transforming
@@ -1307,11 +1261,11 @@ export declare const snakeToCamel: (self: string) => string;
  *
  * **Example** (Converting snake_case to PascalCase)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.snakeToPascal("hello_world")) // "HelloWorld"
- * console.log(String.snakeToPascal("foo_bar_baz")) // "FooBarBaz"
+ * String.snakeToPascal("hello_world") // => "HelloWorld"
+ * String.snakeToPascal("foo_bar_baz") // => "FooBarBaz"
  * ```
  *
  * @category transforming
@@ -1323,11 +1277,11 @@ export declare const snakeToPascal: (self: string) => string;
  *
  * **Example** (Converting snake_case to kebab-case)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.snakeToKebab("hello_world")) // "hello-world"
- * console.log(String.snakeToKebab("foo_bar_baz")) // "foo-bar-baz"
+ * String.snakeToKebab("hello_world") // => "hello-world"
+ * String.snakeToKebab("foo_bar_baz") // => "foo-bar-baz"
  * ```
  *
  * @category transforming
@@ -1339,11 +1293,11 @@ export declare const snakeToKebab: (self: string) => string;
  *
  * **Example** (Converting camelCase to snake_case)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.camelToSnake("helloWorld")) // "hello_world"
- * console.log(String.camelToSnake("fooBarBaz")) // "foo_bar_baz"
+ * String.camelToSnake("helloWorld") // => "hello_world"
+ * String.camelToSnake("fooBarBaz") // => "foo_bar_baz"
  * ```
  *
  * @category transforming
@@ -1355,11 +1309,11 @@ export declare const camelToSnake: (self: string) => string;
  *
  * **Example** (Converting PascalCase to snake_case)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.pascalToSnake("HelloWorld")) // "hello_world"
- * console.log(String.pascalToSnake("FooBarBaz")) // "foo_bar_baz"
+ * String.pascalToSnake("HelloWorld") // => "hello_world"
+ * String.pascalToSnake("FooBarBaz") // => "foo_bar_baz"
  * ```
  *
  * @category transforming
@@ -1371,11 +1325,11 @@ export declare const pascalToSnake: (self: string) => string;
  *
  * **Example** (Converting kebab-case to snake_case)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { String } from "effect"
  *
- * console.log(String.kebabToSnake("hello-world")) // "hello_world"
- * console.log(String.kebabToSnake("foo-bar-baz")) // "foo_bar_baz"
+ * String.kebabToSnake("hello-world") // => "hello_world"
+ * String.kebabToSnake("foo-bar-baz") // => "foo_bar_baz"
  * ```
  *
  * @category transforming