effect 2.0.0-next.37 → 2.0.0-next.38

package/dist/declarations/src/StreamEmit.d.ts

@@ -1,5 +1,5 @@
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 import type * as Cause from "./Cause.js";
 import type * as Chunk from "./Chunk.js";
@@ -14,14 +14,14 @@ import type * as Option from "./Option.js";
  * terminate with that error, and failing with `None` indicates to terminate
  * with an end of stream signal.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface Emit<R, E, A, B> extends EmitOps<R, E, A, B> {
     (f: Effect.Effect<R, Option.Option<E>, Chunk.Chunk<A>>): Promise<B>;
 }
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface EmitOps<R, E, A, B> {

package/dist/declarations/src/StreamHaltStrategy.d.ts

@@ -1,88 +1,88 @@
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export type HaltStrategy = Left | Right | Both | Either;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export type HaltStrategyInput = HaltStrategy | "left" | "right" | "both" | "either";
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface Left {
     readonly _tag: "Left";
 }
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface Right {
     readonly _tag: "Right";
 }
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface Both {
     readonly _tag: "Both";
 }
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface Either {
     readonly _tag: "Either";
 }
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const Left: HaltStrategy;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const Right: HaltStrategy;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const Both: HaltStrategy;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const Either: HaltStrategy;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const fromInput: (input: HaltStrategyInput) => HaltStrategy;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category refinements
  */
 export declare const isLeft: (self: HaltStrategy) => self is Left;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category refinements
  */
 export declare const isRight: (self: HaltStrategy) => self is Right;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category refinements
  */
 export declare const isBoth: (self: HaltStrategy) => self is Both;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category refinements
  */
 export declare const isEither: (self: HaltStrategy) => self is Either;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category folding
  */
 export declare const match: {

package/dist/declarations/src/String.d.ts

@@ -3,7 +3,7 @@
  * It includes functions for basic string manipulation, as well as type class instances for
  * `Equivalence`, `Order`, `Semigroup`, and `Monoid`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 import * as equivalence from "./Equivalence.js";
 import * as Option from "./Option.js";
@@ -23,35 +23,35 @@ import type { NonEmptyArray } from "./ReadonlyArray.js";
  * assert.deepStrictEqual(isString(1), false)
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isString: Refinement<unknown, string>;
 /**
  * @category instances
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const Equivalence: equivalence.Equivalence<string>;
 /**
  * @category instances
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const Order: order.Order<string>;
 /**
  * The empty string `""`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const empty: "";
 /**
  * Concatenates two strings at the type level.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type Concat<A extends string, B extends string> = `${A}${B}`;
 /**
  * Concatenates two strings at runtime.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const concat: {
     <B extends string>(that: B): <A extends string>(self: A) => Concat<A, B>;
@@ -64,7 +64,7 @@ export declare const concat: {
  *
  * assert.deepStrictEqual(pipe('a', S.toUpperCase), 'A')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toUpperCase: <S extends string>(self: S) => Uppercase<S>;
 /**
@@ -74,7 +74,7 @@ export declare const toUpperCase: <S extends string>(self: S) => Uppercase<S>;
  *
  * assert.deepStrictEqual(pipe('A', S.toLowerCase), 'a')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toLowerCase: <T extends string>(self: T) => Lowercase<T>;
 /**
@@ -84,7 +84,7 @@ export declare const toLowerCase: <T extends string>(self: T) => Lowercase<T>;
  *
  * assert.deepStrictEqual(pipe('abc', S.capitalize), 'Abc')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const capitalize: <T extends string>(self: T) => Capitalize<T>;
 /**
@@ -94,7 +94,7 @@ export declare const capitalize: <T extends string>(self: T) => Capitalize<T>;
  *
  * assert.deepStrictEqual(pipe('ABC', S.uncapitalize), 'aBC')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const uncapitalize: <T extends string>(self: T) => Uncapitalize<T>;
 /**
@@ -104,11 +104,11 @@ export declare const uncapitalize: <T extends string>(self: T) => Uncapitalize<T
  *
  * assert.deepStrictEqual(pipe('abc', S.replace('b', 'd')), 'adc')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const replace: (searchValue: string | RegExp, replaceValue: string) => (self: string) => string;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type Trim<A extends string> = TrimEnd<TrimStart<A>>;
 /**
@@ -117,11 +117,11 @@ export type Trim<A extends string> = TrimEnd<TrimStart<A>>;
  *
  * assert.deepStrictEqual(S.trim(' a '), 'a')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const trim: <A extends string>(self: A) => TrimEnd<TrimStart<A>>;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type TrimStart<A extends string> = A extends ` ${infer B}` ? TrimStart<B> : A extends `\n${infer B}` ? TrimStart<B> : A extends `\t${infer B}` ? TrimStart<B> : A extends `\r${infer B}` ? TrimStart<B> : A;
 /**
@@ -130,11 +130,11 @@ export type TrimStart<A extends string> = A extends ` ${infer B}` ? TrimStart<B>
  *
  * assert.deepStrictEqual(S.trimStart(' a '), 'a ')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const trimStart: <A extends string>(self: A) => TrimStart<A>;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type TrimEnd<A extends string> = A extends `${infer B} ` ? TrimEnd<B> : A extends `${infer B}\n` ? TrimEnd<B> : A extends `${infer B}\t` ? TrimEnd<B> : A extends `${infer B}\r` ? TrimEnd<B> : A;
 /**
@@ -143,7 +143,7 @@ export type TrimEnd<A extends string> = A extends `${infer B} ` ? TrimEnd<B> : A
  *
  * assert.deepStrictEqual(S.trimEnd(' a '), ' a')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const trimEnd: <A extends string>(self: A) => TrimEnd<A>;
 /**
@@ -153,7 +153,7 @@ export declare const trimEnd: <A extends string>(self: A) => TrimEnd<A>;
  *
  * assert.deepStrictEqual(pipe('abcd', S.slice(1, 3)), 'bc')
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const slice: (start?: number, end?: number) => (self: string) => string;
 /**
@@ -165,13 +165,13 @@ export declare const slice: (start?: number, end?: number) => (self: string) =>
  * assert.deepStrictEqual(S.isEmpty(''), true)
  * assert.deepStrictEqual(S.isEmpty('a'), false)
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isEmpty: (self: string) => self is "";
 /**
  * Test whether a `string` is non empty.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isNonEmpty: (self: string) => boolean;
 /**
@@ -182,7 +182,7 @@ export declare const isNonEmpty: (self: string) => boolean;
  *
  * assert.deepStrictEqual(S.length('abc'), 3)
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const length: (self: string) => number;
 /**
@@ -193,7 +193,7 @@ export declare const length: (self: string) => number;
  * assert.deepStrictEqual(pipe('abc', S.split('')), ['a', 'b', 'c'])
  * assert.deepStrictEqual(pipe('', S.split('')), [''])
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const split: {
     (separator: string | RegExp): (self: string) => NonEmptyArray<string>;
@@ -203,15 +203,15 @@ export declare const split: {
  * Returns `true` if `searchString` appears as a substring of `self`, at one or more positions that are
  * greater than or equal to `position`; otherwise, returns `false`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const includes: (searchString: string, position?: number) => (self: string) => boolean;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const startsWith: (searchString: string, position?: number) => (self: string) => boolean;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const endsWith: (searchString: string, position?: number) => (self: string) => boolean;
 /**
@@ -223,7 +223,7 @@ export declare const endsWith: (searchString: string, position?: number) => (sel
  * assert.deepStrictEqual(pipe("abc", S.charCodeAt(1)), Option.some(98))
  * assert.deepStrictEqual(pipe("abc", S.charCodeAt(4)), Option.none())
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const charCodeAt: {
     (index: number): (self: string) => Option.Option<number>;
@@ -237,7 +237,7 @@ export declare const charCodeAt: {
  * assert.deepStrictEqual(pipe("abcd", S.substring(1)), "bcd")
  * assert.deepStrictEqual(pipe("abcd", S.substring(1, 3)), "bc")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const substring: (start: number, end?: number) => (self: string) => string;
 /**
@@ -249,7 +249,7 @@ export declare const substring: (start: number, end?: number) => (self: string)
  * assert.deepStrictEqual(pipe("abc", S.at(1)), Option.some("b"))
  * assert.deepStrictEqual(pipe("abc", S.at(4)), Option.none())
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const at: {
     (index: number): (self: string) => Option.Option<string>;
@@ -264,7 +264,7 @@ export declare const at: {
  * assert.deepStrictEqual(pipe("abc", S.charAt(1)), Option.some("b"))
  * assert.deepStrictEqual(pipe("abc", S.charAt(4)), Option.none())
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const charAt: {
     (index: number): (self: string) => Option.Option<string>;
@@ -278,7 +278,7 @@ export declare const charAt: {
  *
  * assert.deepStrictEqual(pipe("abc", S.codePointAt(1)), Option.some(98))
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const codePointAt: {
     (index: number): (self: string) => Option.Option<number>;
@@ -292,7 +292,7 @@ export declare const codePointAt: {
  *
  * assert.deepStrictEqual(pipe("abbbc", S.indexOf("b")), Option.some(1))
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const indexOf: (searchString: string) => (self: string) => Option.Option<number>;
 /**
@@ -304,7 +304,7 @@ export declare const indexOf: (searchString: string) => (self: string) => Option
  * assert.deepStrictEqual(pipe("abbbc", S.lastIndexOf("b")), Option.some(3))
  * assert.deepStrictEqual(pipe("abbbc", S.lastIndexOf("d")), Option.none())
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const lastIndexOf: (searchString: string) => (self: string) => Option.Option<number>;
 /**
@@ -316,19 +316,19 @@ export declare const lastIndexOf: (searchString: string) => (self: string) => Op
  * assert.deepStrictEqual(pipe("b", S.localeCompare("a")), 1)
  * assert.deepStrictEqual(pipe("a", S.localeCompare("a")), 0)
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const localeCompare: (that: string, locales?: Array<string>, options?: Intl.CollatorOptions) => (self: string) => Ordering.Ordering;
 /**
  * It is the `pipe`-able version of the native `match` method.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const match: (regexp: RegExp | string) => (self: string) => Option.Option<RegExpMatchArray>;
 /**
  * It is the `pipe`-able version of the native `matchAll` method.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const matchAll: (regexp: RegExp) => (self: string) => IterableIterator<RegExpMatchArray>;
 /**
@@ -343,7 +343,7 @@ export declare const matchAll: (regexp: RegExp) => (self: string) => IterableIte
  * assert.deepStrictEqual(pipe(str, S.normalize("NFKC")), "\u1E69")
  * assert.deepStrictEqual(pipe(str, S.normalize("NFKD")), "\u0073\u0323\u0307")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const normalize: (form?: "NFC" | "NFD" | "NFKC" | "NFKD") => (self: string) => string;
 /**
@@ -354,7 +354,7 @@ export declare const normalize: (form?: "NFC" | "NFD" | "NFKC" | "NFKD") => (sel
  * assert.deepStrictEqual(pipe("a", S.padEnd(5)), "a    ")
  * assert.deepStrictEqual(pipe("a", S.padEnd(5, "_")), "a____")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const padEnd: (maxLength: number, fillString?: string) => (self: string) => string;
 /**
@@ -365,7 +365,7 @@ export declare const padEnd: (maxLength: number, fillString?: string) => (self:
  * assert.deepStrictEqual(pipe("a", S.padStart(5)), "    a")
  * assert.deepStrictEqual(pipe("a", S.padStart(5, "_")), "____a")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const padStart: (maxLength: number, fillString?: string) => (self: string) => string;
 /**
@@ -375,7 +375,7 @@ export declare const padStart: (maxLength: number, fillString?: string) => (self
  *
  * assert.deepStrictEqual(pipe("a", S.repeat(5)), "aaaaa")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const repeat: (count: number) => (self: string) => string;
 /**
@@ -386,7 +386,7 @@ export declare const repeat: (count: number) => (self: string) => string;
  * assert.deepStrictEqual(pipe("ababb", S.replaceAll("b", "c")), "acacc")
  * assert.deepStrictEqual(pipe("ababb", S.replaceAll(/ba/g, "cc")), "accbb")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const replaceAll: (searchValue: string | RegExp, replaceValue: string) => (self: string) => string;
 /**
@@ -399,7 +399,7 @@ export declare const replaceAll: (searchValue: string | RegExp, replaceValue: st
  * assert.deepStrictEqual(pipe("ababb", S.search(/abb/)), Option.some(2))
  * assert.deepStrictEqual(pipe("ababb", S.search("d")), Option.none())
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const search: {
     (regexp: RegExp | string): (self: string) => Option.Option<number>;
@@ -413,7 +413,7 @@ export declare const search: {
  * const str = "\u0130"
  * assert.deepStrictEqual(pipe(str, S.toLocaleLowerCase("tr")), "i")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toLocaleLowerCase: (locale?: string | Array<string>) => (self: string) => string;
 /**
@@ -424,7 +424,7 @@ export declare const toLocaleLowerCase: (locale?: string | Array<string>) => (se
  * const str = "i\u0307"
  * assert.deepStrictEqual(pipe(str, S.toLocaleUpperCase("lt-LT")), "I")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toLocaleUpperCase: (locale?: string | Array<string>) => (self: string) => string;
 /**
@@ -442,7 +442,7 @@ export declare const toLocaleUpperCase: (locale?: string | Array<string>) => (se
  *
  * assert.deepStrictEqual(S.takeLeft("Hello World", 5), "Hello")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const takeLeft: {
     (n: number): (self: string) => string;
@@ -463,7 +463,7 @@ export declare const takeLeft: {
  *
  * assert.deepStrictEqual(S.takeRight("Hello World", 5), "World")
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const takeRight: {
     (n: number): (self: string) => string;
@@ -473,13 +473,13 @@ export declare const takeRight: {
  * Returns an `IterableIterator` which yields each line contained within the
  * string, trimming off the trailing newline character.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 /**
  * Returns an `IterableIterator` which yields each line contained within the
  * string as well as the trailing newline character.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const linesWithSeparators: (s: string) => LinesIterator;
 /**
@@ -487,7 +487,7 @@ export declare const linesWithSeparators: (s: string) => LinesIterator;
  * or control characters followed by the character specified by `marginChar`
  * from the line.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const stripMarginWith: {
     (marginChar: string): (self: string) => string;
@@ -497,7 +497,7 @@ export declare const stripMarginWith: {
  * For every line in this string, strip a leading prefix consisting of blanks
  * or control characters followed by the `"|"` character from the line.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const stripMargin: (self: string) => string;
 declare class LinesIterator implements IterableIterator<string> {

package/dist/declarations/src/Struct.d.ts

@@ -1,7 +1,7 @@
 /**
  * This module provides utility functions for working with structs in TypeScript.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 import * as Equivalence from "./Equivalence.js";
 import * as order from "./Order.js";
@@ -14,7 +14,7 @@ import * as order from "./Order.js";
  *
  * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, pick("a", "b")), { a: "a", b: 1 })
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const pick: <S, Keys extends readonly [keyof S, ...(keyof S)[]]>(...keys: Keys) => (s: S) => { [K in Keys[number]]: S[K]; };
 /**
@@ -26,7 +26,7 @@ export declare const pick: <S, Keys extends readonly [keyof S, ...(keyof S)[]]>(
  *
  * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, omit("c")), { a: "a", b: 1 })
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const omit: <S, Keys extends readonly [keyof S, ...(keyof S)[]]>(...keys: Keys) => (s: S) => { [K in Exclude<keyof S, Keys[number]>]: S[K]; };
 /**
@@ -55,7 +55,7 @@ export declare const omit: <S, Keys extends readonly [keyof S, ...(keyof S)[]]>(
  * )
  *
  * @category combinators
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getEquivalence: <R extends Record<string, Equivalence.Equivalence<any>>>(isEquivalents: R) => Equivalence.Equivalence<{
     readonly [K in keyof R]: [R[K]] extends [Equivalence.Equivalence<infer A>] ? A : never;
@@ -67,7 +67,7 @@ export declare const getEquivalence: <R extends Record<string, Equivalence.Equiv
  * Alias of {@link order.struct}.
  *
  * @category combinators
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrder: <R extends {
     readonly [x: string]: order.Order<any>;
@@ -99,7 +99,7 @@ type Transformed<O, T extends PartialTransform<O>> = unknown & {
  *   { a: 1, b: 2, c: 3 }
  * )
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const evolve: {
     <O, T extends PartialTransform<O>>(t: T): (obj: O) => Transformed<O, T>;