effect 4.0.1 → 4.0.2

package/dist/String.d.ts

@@ -6,6 +6,7 @@
  * padding, replacement, normalization, safe character access, search helpers
  * that return `Option`, and joining strings through a reducer.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type { NonEmptyArray } from "./Array.ts";
@@ -30,6 +31,7 @@ import * as Reducer from "./Reducer.ts";
  *
  * @see {@link isString} for checking whether a value is a primitive string
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -46,6 +48,7 @@ export declare const String: StringConstructor;
  * String.isString(1) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -64,6 +67,7 @@ export declare const isString: Refinement<unknown, string>;
  * String.Order("apple", "apple") // => 0
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -80,6 +84,7 @@ export declare const Order: order.Order<string>;
  * String.Equivalence("hello", "world") // => false
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -100,6 +105,7 @@ export declare const Equivalence: Equ.Equivalence<string>;
  * String.isEmpty(String.empty) // => true
  * ```
  *
+ * @stability stable
  * @category constants
  * @since 2.0.0
  */
@@ -118,6 +124,7 @@ export declare const empty: "";
  * const witness: Result = "helloworld"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -134,6 +141,7 @@ export type Concat<A extends string, B extends string> = `${A}${B}`;
  * pipe("hello", String.concat("world")) // => "helloworld"
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -150,6 +158,7 @@ export declare const concat: {
      * pipe("hello", String.concat("world")) // => "helloworld"
      * ```
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -166,6 +175,7 @@ export declare const concat: {
      * pipe("hello", String.concat("world")) // => "helloworld"
      * ```
      *
+     * @stability stable
      * @category combining
      * @since 2.0.0
      */
@@ -183,6 +193,7 @@ export declare const concat: {
  * String.toUpperCase("hello") // => "HELLO"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -199,6 +210,7 @@ export declare const toUpperCase: <S extends string>(self: S) => Uppercase<S>;
  * String.toLowerCase("HELLO") // => "hello"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -215,6 +227,7 @@ export declare const toLowerCase: <T extends string>(self: T) => Lowercase<T>;
  * String.capitalize("hello") // => "Hello"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -231,6 +244,7 @@ export declare const capitalize: <T extends string>(self: T) => Capitalize<T>;
  * String.uncapitalize("Hello") // => "hello"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -252,6 +266,7 @@ export declare const uncapitalize: <T extends string>(self: T) => Uncapitalize<T
  * pipe("hello world", String.replace("world", "Effect")) // => "hello Effect"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -269,6 +284,7 @@ export declare const replace: (searchValue: string | RegExp, replaceValue: strin
  * const witness: Result = "hello"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -285,6 +301,7 @@ export type Trim<A extends string> = TrimEnd<TrimStart<A>>;
  * String.trim("  hello world  ") // => "hello world"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -302,6 +319,7 @@ export declare const trim: <A extends string>(self: A) => Trim<A>;
  * const witness: Result = "hello"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -318,6 +336,7 @@ export type TrimStart<A extends string> = A extends `${" " | "\n" | "\t" | "\r"}
  * String.trimStart("  hello world") // => "hello world"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -335,6 +354,7 @@ export declare const trimStart: <A extends string>(self: A) => TrimStart<A>;
  * const witness: Result = "hello"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -351,6 +371,7 @@ export type TrimEnd<A extends string> = A extends `${infer B}${" " | "\n" | "\t"
  * String.trimEnd("hello world  ") // => "hello world"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -367,6 +388,7 @@ export declare const trimEnd: <A extends string>(self: A) => TrimEnd<A>;
  * pipe("hello world", String.slice(0, 5)) // => "hello"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -383,6 +405,7 @@ export declare const slice: (start?: number, end?: number) => (self: string) =>
  * String.isEmpty("a") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -399,6 +422,7 @@ export declare const isEmpty: (self: string) => self is "";
  * String.isNonEmpty("a") // => true
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -414,6 +438,7 @@ export declare const isNonEmpty: (self: string) => boolean;
  * String.length("abc") // => 3
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -431,6 +456,7 @@ export declare const length: (self: string) => number;
  * String.split("hello,world", ",") // => ["hello", "world"]
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -448,6 +474,7 @@ export declare const split: {
      * String.split("hello,world", ",") // => ["hello", "world"]
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -465,6 +492,7 @@ export declare const split: {
      * String.split("hello,world", ",") // => ["hello", "world"]
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -483,6 +511,7 @@ export declare const split: {
  * pipe("hello world", String.includes("foo")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -499,6 +528,7 @@ export declare const includes: (searchString: string, position?: number) => (sel
  * pipe("hello world", String.startsWith("world")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -515,6 +545,7 @@ export declare const startsWith: (searchString: string, position?: number) => (s
  * pipe("hello world", String.endsWith("hello")) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -531,6 +562,7 @@ export declare const endsWith: (searchString: string, position?: number) => (sel
  * String.charCodeAt("abc", 4) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -547,6 +579,7 @@ export declare const charCodeAt: {
      * String.charCodeAt("abc", 4) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -563,6 +596,7 @@ export declare const charCodeAt: {
      * String.charCodeAt("abc", 4) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -580,6 +614,7 @@ export declare const charCodeAt: {
  * pipe("abcd", String.substring(1, 3)) // => "bc"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -596,6 +631,7 @@ export declare const substring: (start: number, end?: number) => (self: string)
  * pipe("abc", String.at(4)) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -612,6 +648,7 @@ export declare const at: {
      * pipe("abc", String.at(4)) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -628,6 +665,7 @@ export declare const at: {
      * pipe("abc", String.at(4)) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -645,6 +683,7 @@ export declare const at: {
  * pipe("abc", String.charAt(4)) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -661,6 +700,7 @@ export declare const charAt: {
      * pipe("abc", String.charAt(4)) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -677,6 +717,7 @@ export declare const charAt: {
      * pipe("abc", String.charAt(4)) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -694,6 +735,7 @@ export declare const charAt: {
  * pipe("abc", String.codePointAt(10)) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -710,6 +752,7 @@ export declare const codePointAt: {
      * pipe("abc", String.codePointAt(10)) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -726,6 +769,7 @@ export declare const codePointAt: {
      * pipe("abc", String.codePointAt(10)) // => Option.none()
      * ```
      *
+     * @stability stable
      * @category getters
      * @since 2.0.0
      */
@@ -743,6 +787,7 @@ export declare const codePointAt: {
  * pipe("abbbc", String.indexOf("z")) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -759,6 +804,7 @@ export declare const indexOf: (searchString: string) => (self: string) => Option
  * pipe("abbbc", String.lastIndexOf("d")) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -778,6 +824,7 @@ export declare const lastIndexOf: (searchString: string) => (self: string) => Op
  * pipe("a", String.localeCompare("a")) // => 0
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 2.0.0
  */
@@ -799,6 +846,7 @@ export declare const localeCompare: (that: string, locales?: Array<string>, opti
  * pipe("hello", String.match(/x/)) // => Option.none()
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -817,6 +865,7 @@ export declare const match: (regExp: RegExp | string) => (self: string) => Optio
  * Array.from(matches, (match) => [match[0], match.index]) // => [["l", 2], ["l", 3], ["l", 9]]
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -843,6 +892,7 @@ export declare const matchAll: (regExp: RegExp) => (self: string) => IterableIte
  * ) // => [0x73, 0x323, 0x307]
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -859,6 +909,7 @@ export declare const normalize: (form?: "NFC" | "NFD" | "NFKC" | "NFKD") => (sel
  * pipe("a", String.padEnd(5, "_")) // => "a____"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -875,6 +926,7 @@ export declare const padEnd: (maxLength: number, fillString?: string) => (self:
  * pipe("a", String.padStart(5, "_")) // => "____a"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -895,6 +947,7 @@ export declare const padStart: (maxLength: number, fillString?: string) => (self
  * pipe("hello", String.repeat(3)) // => "hellohellohello"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -911,6 +964,7 @@ export declare const repeat: (count: number) => (self: string) => string;
  * pipe("ababb", String.replaceAll(/ba/g, "cc")) // => "accbb"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -929,6 +983,7 @@ export declare const replaceAll: (searchValue: string | RegExp, replaceValue: st
  * String.search("ababb", "d") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category searching
  * @since 2.0.0
  */
@@ -947,6 +1002,7 @@ export declare const search: {
      * String.search("ababb", "d") // => Option.none()
      * ```
      *
+     * @stability stable
      * @category searching
      * @since 2.0.0
      */
@@ -965,6 +1021,7 @@ export declare const search: {
      * String.search("ababb", "d") // => Option.none()
      * ```
      *
+     * @stability stable
      * @category searching
      * @since 2.0.0
      */
@@ -982,6 +1039,7 @@ export declare const search: {
  * pipe(str, String.toLocaleLowerCase("tr")) // => "i"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -998,6 +1056,7 @@ export declare const toLocaleLowerCase: (locale?: string | Array<string>) => (se
  * pipe(str, String.toLocaleUpperCase("lt-LT")) // => "I"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1023,6 +1082,7 @@ export declare const toLocaleUpperCase: (locale?: string | Array<string>) => (se
  * String.takeLeft("Hello World", 5) // => "Hello"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1048,6 +1108,7 @@ export declare const takeLeft: {
      * String.takeLeft("Hello World", 5) // => "Hello"
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1073,6 +1134,7 @@ export declare const takeLeft: {
      * String.takeLeft("Hello World", 5) // => "Hello"
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1099,6 +1161,7 @@ export declare const takeLeft: {
  * String.takeRight("Hello World", 5) // => "World"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1124,6 +1187,7 @@ export declare const takeRight: {
      * String.takeRight("Hello World", 5) // => "World"
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1149,6 +1213,7 @@ export declare const takeRight: {
      * String.takeRight("Hello World", 5) // => "World"
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1166,6 +1231,7 @@ export declare const takeRight: {
  * Array.from(String.linesIterator("hello\nworld\n")) // => ["hello", "world"]
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1182,6 +1248,7 @@ export declare const linesIterator: (self: string) => LinesIterator;
  * Array.from(String.linesWithSeparators("hello\nworld\n")) // => ["hello\n", "world\n"]
  * ```
  *
+ * @stability stable
  * @category splitting
  * @since 2.0.0
  */
@@ -1198,6 +1265,7 @@ export declare const linesWithSeparators: (s: string) => LinesIterator;
  * String.stripMarginWith("  |hello\n  |world", "|") // => "hello\nworld"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1214,6 +1282,7 @@ export declare const stripMarginWith: {
      * String.stripMarginWith("  |hello\n  |world", "|") // => "hello\nworld"
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1230,6 +1299,7 @@ export declare const stripMarginWith: {
      * String.stripMarginWith("  |hello\n  |world", "|") // => "hello\nworld"
      * ```
      *
+     * @stability stable
      * @category transforming
      * @since 2.0.0
      */
@@ -1246,6 +1316,7 @@ export declare const stripMarginWith: {
  * String.stripMargin("  |hello\n  |world") // => "hello\nworld"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1262,6 +1333,7 @@ export declare const stripMargin: (self: string) => string;
  * String.snakeToCamel("foo_bar_baz") // => "fooBarBaz"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1278,6 +1350,7 @@ export declare const snakeToCamel: (self: string) => string;
  * String.snakeToPascal("foo_bar_baz") // => "FooBarBaz"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1294,6 +1367,7 @@ export declare const snakeToPascal: (self: string) => string;
  * String.snakeToKebab("foo_bar_baz") // => "foo-bar-baz"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1310,6 +1384,7 @@ export declare const snakeToKebab: (self: string) => string;
  * String.camelToSnake("fooBarBaz") // => "foo_bar_baz"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1326,6 +1401,7 @@ export declare const camelToSnake: (self: string) => string;
  * String.pascalToSnake("FooBarBaz") // => "foo_bar_baz"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1342,6 +1418,7 @@ export declare const pascalToSnake: (self: string) => string;
  * String.kebabToSnake("foo-bar-baz") // => "foo_bar_baz"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */
@@ -1371,6 +1448,7 @@ declare class LinesIterator implements IterableIterator<string> {
  * @see {@link kebabCase} for fixed lowercase hyphen-separated output
  * @see {@link snakeCase} for fixed lowercase underscore-separated output
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1390,6 +1468,7 @@ export declare const noCase: {
      * @see {@link kebabCase} for fixed lowercase hyphen-separated output
      * @see {@link snakeCase} for fixed lowercase underscore-separated output
      *
+     * @stability stable
      * @category transforming
      * @since 4.0.0
      */
@@ -1414,6 +1493,7 @@ export declare const noCase: {
      * @see {@link kebabCase} for fixed lowercase hyphen-separated output
      * @see {@link snakeCase} for fixed lowercase underscore-separated output
      *
+     * @stability stable
      * @category transforming
      * @since 4.0.0
      */
@@ -1436,6 +1516,7 @@ export declare const noCase: {
  * @see {@link noCase} for configurable delimiters and part transforms
  * @see {@link snakeToPascal} for converting known snake_case input only
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1454,6 +1535,7 @@ export declare const pascalCase: (self: string) => string;
  * @see {@link kebabCase} for lowercase hyphen-separated output
  * @see {@link constantCase} for uppercase underscore-separated output
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1473,6 +1555,7 @@ export declare const camelCase: (self: string) => string;
  * @see {@link configCase} for configuration key casing that preserves numeric word groups
  * @see {@link noCase} for configurable delimiters and part transforms
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1492,6 +1575,7 @@ export declare const constantCase: (self: string) => string;
  * example, `"api-v2 xml"` becomes `"API_V2_XML"`.
  *
  * @see {@link constantCase} for standard uppercase underscore-separated output
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1510,6 +1594,7 @@ export declare const configCase: (self: string) => string;
  * @see {@link camelCase} for lower-initial camelCase output
  * @see {@link pascalCase} for upper-initial PascalCase output
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1526,6 +1611,7 @@ export declare const kebabCase: (self: string) => string;
  * @see {@link kebabCase} for lowercase hyphen-separated output
  * @see {@link constantCase} for uppercase underscore-separated output
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1543,6 +1629,7 @@ export declare const snakeCase: (self: string) => string;
  *
  * @see {@link concat} for concatenating two strings directly
  *
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */