effect 2.0.0-next.37 → 2.0.0-next.39

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

@@ -1,7 +1,7 @@
 /**
  * This module provides utility functions for working with arrays in TypeScript.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 import type { Either } from "./Either.js";
 import * as Equivalence from "./Equivalence.js";
@@ -12,26 +12,26 @@ import * as Order from "./Order.js";
 import type { Predicate, Refinement } from "./Predicate.js";
 /**
  * @category type lambdas
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface ReadonlyArrayTypeLambda extends TypeLambda {
     readonly type: ReadonlyArray<this["Target"]>;
 }
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type NonEmptyReadonlyArray<A> = readonly [A, ...Array<A>];
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type NonEmptyArray<A> = [A, ...Array<A>];
 /**
  * Builds a `NonEmptyArray` from an non-empty collection of elements.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const make: <Elements extends [any, ...any[]]>(...elements: Elements) => [Elements[number], ...Elements[number][]];
 /**
@@ -45,7 +45,7 @@ export declare const make: <Elements extends [any, ...any[]]>(...elements: Eleme
  * assert.deepStrictEqual(makeBy(5, n => n * 2), [0, 2, 4, 6, 8])
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const makeBy: <A>(n: number, f: (i: number) => A) => [A, ...A[]];
 /**
@@ -57,7 +57,7 @@ export declare const makeBy: <A>(n: number, f: (i: number) => A) => [A, ...A[]];
  * assert.deepStrictEqual(range(1, 3), [1, 2, 3])
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const range: (start: number, end: number) => [number, ...number[]];
 /**
@@ -71,7 +71,7 @@ export declare const range: (start: number, end: number) => [number, ...number[]
  * assert.deepStrictEqual(replicate("a", 3), ["a", "a", "a"])
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const replicate: {
     (n: number): <A>(a: A) => NonEmptyArray<A>;
@@ -79,7 +79,7 @@ export declare const replicate: {
 };
 /**
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromIterable: <A>(collection: Iterable<A>) => A[];
 /**
@@ -94,17 +94,17 @@ export declare const fromIterable: <A>(collection: Iterable<A>) => A[];
  * assert.deepStrictEqual(fromRecord(x), [["a", 1], ["b", 2], ["c", 3]])
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromRecord: <K extends string, A>(self: Readonly<Record<K, A>>) => Array<[K, A]>;
 /**
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromOption: <A>(self: Option<A>) => Array<A>;
 /**
  * @category pattern matching
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const match: {
     <B, A, C = B>(options: {
@@ -118,7 +118,7 @@ export declare const match: {
 };
 /**
  * @category pattern matching
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const matchLeft: {
     <B, A, C = B>(options: {
@@ -132,7 +132,7 @@ export declare const matchLeft: {
 };
 /**
  * @category pattern matching
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const matchRight: {
     <B, A, C = B>(options: {
@@ -148,7 +148,7 @@ export declare const matchRight: {
  * Prepend an element to the front of an `Iterable`, creating a new `NonEmptyArray`.
  *
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const prepend: {
     <B>(head: B): <A>(self: Iterable<A>) => NonEmptyArray<A | B>;
@@ -156,7 +156,7 @@ export declare const prepend: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const prependAll: {
     <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<A | B>;
@@ -164,7 +164,7 @@ export declare const prependAll: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const prependAllNonEmpty: {
     <B>(that: NonEmptyReadonlyArray<B>): <A>(self: Iterable<A>) => NonEmptyArray<A | B>;
@@ -176,7 +176,7 @@ export declare const prependAllNonEmpty: {
  * Append an element to the end of an `Iterable`, creating a new `NonEmptyArray`.
  *
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const append: {
     <B>(last: B): <A>(self: Iterable<A>) => NonEmptyArray<A | B>;
@@ -184,7 +184,7 @@ export declare const append: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const appendAll: {
     <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<A | B>;
@@ -192,7 +192,7 @@ export declare const appendAll: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const appendAllNonEmpty: {
     <B>(that: NonEmptyReadonlyArray<B>): <A>(self: Iterable<A>) => NonEmptyArray<A | B>;
@@ -204,7 +204,7 @@ export declare const appendAllNonEmpty: {
  * Reduce an `Iterable` from the left, keeping all intermediate results instead of only the final result.
  *
  * @category folding
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const scan: {
     <B, A>(b: B, f: (b: B, a: A) => B): (self: Iterable<A>) => NonEmptyArray<B>;
@@ -214,7 +214,7 @@ export declare const scan: {
  * Reduce an `Iterable` from the right, keeping all intermediate results instead of only the final result.
  *
  * @category folding
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const scanRight: {
     <B, A>(b: B, f: (b: B, a: A) => B): (self: Iterable<A>) => NonEmptyArray<B>;
@@ -232,7 +232,7 @@ export declare const scanRight: {
  * assert.deepStrictEqual(isEmptyArray([1, 2, 3]), false);
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isEmptyArray: <A>(self: A[]) => self is [];
 /**
@@ -247,7 +247,7 @@ export declare const isEmptyArray: <A>(self: A[]) => self is [];
  * assert.deepStrictEqual(isEmptyReadonlyArray([1, 2, 3]), false);
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isEmptyReadonlyArray: <A>(self: ReadonlyArray<A>) => self is readonly [];
 /**
@@ -264,7 +264,7 @@ export declare const isEmptyReadonlyArray: <A>(self: ReadonlyArray<A>) => self i
  * assert.deepStrictEqual(isNonEmptyArray([1, 2, 3]), true);
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isNonEmptyArray: <A>(self: Array<A>) => self is NonEmptyArray<A>;
 /**
@@ -281,21 +281,21 @@ export declare const isNonEmptyArray: <A>(self: Array<A>) => self is NonEmptyArr
  * assert.deepStrictEqual(isNonEmptyReadonlyArray([1, 2, 3]), true);
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isNonEmptyReadonlyArray: <A>(self: ReadonlyArray<A>) => self is NonEmptyReadonlyArray<A>;
 /**
  * Return the number of elements in a `ReadonlyArray`.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const length: <A>(self: readonly A[]) => number;
 /**
  * This function provides a safe way to read a value at a particular index from a `ReadonlyArray`.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const get: {
     (index: number): <A>(self: ReadonlyArray<A>) => Option<A>;
@@ -304,7 +304,7 @@ export declare const get: {
 /**
  * Gets an element unsafely, will throw on out of bounds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category unsafe
  */
 export declare const unsafeGet: {
@@ -315,64 +315,64 @@ export declare const unsafeGet: {
  * Return a tuple containing the first element, and a new `Array` of the remaining elements, if any.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unprepend: <A>(self: readonly [A, ...A[]]) => [A, A[]];
 /**
  * Return a tuple containing a copy of the `NonEmptyReadonlyArray` without its last element, and that last element.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unappend: <A>(self: readonly [A, ...A[]]) => [A[], A];
 /**
  * Get the first element of a `ReadonlyArray`, or `None` if the `ReadonlyArray` is empty.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const head: <A>(self: ReadonlyArray<A>) => Option<A>;
 /**
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const headNonEmpty: <A>(self: NonEmptyReadonlyArray<A>) => A;
 /**
  * Get the last element in a `ReadonlyArray`, or `None` if the `ReadonlyArray` is empty.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const last: <A>(self: readonly A[]) => Option<A>;
 /**
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const lastNonEmpty: <A>(self: readonly [A, ...A[]]) => A;
 /**
  * Get all but the first element of an `Iterable`, creating a new `Array`, or `None` if the `Iterable` is empty.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const tail: <A>(self: Iterable<A>) => Option<A[]>;
 /**
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const tailNonEmpty: <A>(self: readonly [A, ...A[]]) => A[];
 /**
  * Get all but the last element of an `Iterable`, creating a new `Array`, or `None` if the `Iterable` is empty.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const init: <A>(self: Iterable<A>) => Option<A[]>;
 /**
  * Get all but the last element of a non empty array, creating a new array.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const initNonEmpty: <A>(self: readonly [A, ...A[]]) => A[];
 /**
@@ -381,7 +381,7 @@ export declare const initNonEmpty: <A>(self: readonly [A, ...A[]]) => A[];
  * **Note**. `n` is normalized to a non negative integer.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const take: {
     (n: number): <A>(self: Iterable<A>) => Array<A>;
@@ -393,7 +393,7 @@ export declare const take: {
  * **Note**. `n` is normalized to a non negative integer.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const takeRight: {
     (n: number): <A>(self: Iterable<A>) => Array<A>;
@@ -403,7 +403,7 @@ export declare const takeRight: {
  * Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const takeWhile: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: Iterable<A>) => Array<B>;
@@ -418,7 +418,7 @@ export declare const takeWhile: {
  * 2. the remaining elements
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const span: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: Iterable<A>) => [init: Array<B>, rest: Array<A>];
@@ -432,7 +432,7 @@ export declare const span: {
  * **Note**. `n` is normalized to a non negative integer.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const drop: {
     (n: number): <A>(self: Iterable<A>) => Array<A>;
@@ -444,7 +444,7 @@ export declare const drop: {
  * **Note**. `n` is normalized to a non negative integer.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dropRight: {
     (n: number): <A>(self: Iterable<A>) => Array<A>;
@@ -454,7 +454,7 @@ export declare const dropRight: {
  * Remove the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dropWhile: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: Iterable<A>) => Array<B>;
@@ -466,7 +466,7 @@ export declare const dropWhile: {
  * Return the first index for which a predicate holds.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const findFirstIndex: {
     <A>(predicate: Predicate<A>): (self: Iterable<A>) => Option<number>;
@@ -476,7 +476,7 @@ export declare const findFirstIndex: {
  * Return the last index for which a predicate holds.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const findLastIndex: {
     <A>(predicate: Predicate<A>): (self: Iterable<A>) => Option<number>;
@@ -487,7 +487,7 @@ export declare const findLastIndex: {
  * predicate, or `None` if no such element exists.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const findFirst: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: Iterable<A>) => Option<B>;
@@ -499,7 +499,7 @@ export declare const findFirst: {
  * Find the last element for which a predicate holds.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const findLast: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: Iterable<A>) => Option<B>;
@@ -511,7 +511,7 @@ export declare const findLast: {
  * Insert an element at the specified index, creating a new `NonEmptyArray`,
  * or return `None` if the index is out of bounds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const insertAt: {
     <B>(i: number, b: B): <A>(self: Iterable<A>) => Option<NonEmptyArray<A | B>>;
@@ -521,14 +521,14 @@ export declare const insertAt: {
  * Change the element at the specified index, creating a new `Array`,
  * or return a copy of the input if the index is out of bounds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const replace: {
     <B>(i: number, b: B): <A>(self: Iterable<A>) => Array<A | B>;
     <A, B>(self: Iterable<A>, i: number, b: B): Array<A | B>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const replaceOption: {
     <B>(i: number, b: B): <A>(self: Iterable<A>) => Option<Array<A | B>>;
@@ -538,7 +538,7 @@ export declare const replaceOption: {
  * Apply a function to the element at the specified index, creating a new `Array`,
  * or return a copy of the input if the index is out of bounds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const modify: {
     <A, B>(i: number, f: (a: A) => B): (self: Iterable<A>) => Array<A | B>;
@@ -548,7 +548,7 @@ export declare const modify: {
  * Apply a function to the element at the specified index, creating a new `Array`,
  * or return `None` if the index is out of bounds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const modifyOption: {
     <A, B>(i: number, f: (a: A) => B): (self: Iterable<A>) => Option<Array<A | B>>;
@@ -558,7 +558,7 @@ export declare const modifyOption: {
  * Delete the element at the specified index, creating a new `Array`,
  * or return a copy of the input if the index is out of bounds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const remove: {
     (i: number): <A>(self: Iterable<A>) => Array<A>;
@@ -568,26 +568,26 @@ export declare const remove: {
  * Reverse an `Iterable`, creating a new `Array`.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const reverse: <A>(self: Iterable<A>) => A[];
 /**
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const reverseNonEmpty: <A>(self: readonly [A, ...A[]]) => [A, ...A[]];
 /**
  * Sort the elements of an `Iterable` in increasing order, creating a new `Array`.
  *
  * @category sorting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const sort: {
     <B>(O: Order.Order<B>): <A extends B>(self: Iterable<A>) => Array<A>;
     <A extends B, B>(self: Iterable<A>, O: Order.Order<B>): Array<A>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const sortWith: {
@@ -598,7 +598,7 @@ export declare const sortWith: {
  * Sort the elements of a `NonEmptyReadonlyArray` in increasing order, creating a new `NonEmptyArray`.
  *
  * @category sorting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const sortNonEmpty: {
     <B>(O: Order.Order<B>): <A extends B>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A>;
@@ -609,12 +609,12 @@ export declare const sortNonEmpty: {
  * using first `orders[0]`, then `orders[1]`, etc...
  *
  * @category sorting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const sortBy: <B>(...orders: readonly Order.Order<B>[]) => <A extends B>(self: Iterable<A>) => A[];
 /**
  * @category sorting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const sortByNonEmpty: <B>(...orders: readonly Order.Order<B>[]) => <A extends B>(as: readonly [A, ...A[]]) => [A, ...A[]];
 /**
@@ -622,7 +622,7 @@ export declare const sortByNonEmpty: <B>(...orders: readonly Order.Order<B>[]) =
  * If one input `Iterable` is short, excess elements of the
  * longer `Iterable` are discarded.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zip: {
     <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<[A, B]>;
@@ -632,21 +632,21 @@ export declare const zip: {
  * Apply a function to pairs of elements at the same index in two `Iterable`s, collecting the results in a new `Array`. If one
  * input `Iterable` is short, excess elements of the longer `Iterable` are discarded.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zipWith: {
     <B, A, C>(that: Iterable<B>, f: (a: A, b: B) => C): (self: Iterable<A>) => Array<C>;
     <B, A, C>(self: Iterable<A>, that: Iterable<B>, f: (a: A, b: B) => C): Array<C>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zipNonEmpty: {
     <B>(that: NonEmptyReadonlyArray<B>): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<[A, B]>;
     <A, B>(self: NonEmptyReadonlyArray<A>, that: NonEmptyReadonlyArray<B>): NonEmptyArray<[A, B]>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zipNonEmptyWith: {
     <B, A, C>(that: NonEmptyReadonlyArray<B>, f: (a: A, b: B) => C): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<C>;
@@ -655,17 +655,17 @@ export declare const zipNonEmptyWith: {
 /**
  * This function is the inverse of `zip`. Takes an `Iterable` of pairs and return two corresponding `Array`s.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unzip: <A, B>(self: Iterable<readonly [A, B]>) => [A[], B[]];
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unzipNonEmpty: <A, B>(self: readonly [readonly [A, B], ...(readonly [A, B])[]]) => [[A, ...A[]], [B, ...B[]]];
 /**
  * Places an element in between members of an `Iterable`
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const intersperse: {
     <B>(middle: B): <A>(self: Iterable<A>) => Array<A | B>;
@@ -674,7 +674,7 @@ export declare const intersperse: {
 /**
  * Places an element in between members of a `NonEmptyReadonlyArray`
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const intersperseNonEmpty: {
     <B>(middle: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>;
@@ -683,7 +683,7 @@ export declare const intersperseNonEmpty: {
 /**
  * Apply a function to the head, creating a new `NonEmptyReadonlyArray`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const modifyNonEmptyHead: {
     <A, B>(f: (a: A) => B): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>;
@@ -692,7 +692,7 @@ export declare const modifyNonEmptyHead: {
 /**
  * Change the head, creating a new `NonEmptyReadonlyArray`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const setNonEmptyHead: {
     <B>(b: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>;
@@ -701,7 +701,7 @@ export declare const setNonEmptyHead: {
 /**
  * Apply a function to the last element, creating a new `NonEmptyReadonlyArray`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const modifyNonEmptyLast: {
     <A, B>(f: (a: A) => B): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>;
@@ -710,7 +710,7 @@ export declare const modifyNonEmptyLast: {
 /**
  * Change the last element, creating a new `NonEmptyReadonlyArray`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const setNonEmptyLast: {
     <B>(b: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>;
@@ -719,7 +719,7 @@ export declare const setNonEmptyLast: {
 /**
  * Rotate an `Iterable` by `n` steps.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const rotate: {
     (n: number): <A>(self: Iterable<A>) => Array<A>;
@@ -728,7 +728,7 @@ export declare const rotate: {
 /**
  * Rotate a `NonEmptyReadonlyArray` by `n` steps.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const rotateNonEmpty: {
     (n: number): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A>;
@@ -738,7 +738,7 @@ export declare const rotateNonEmpty: {
  * Returns a function that checks if a `ReadonlyArray` contains a given value using a provided `isEquivalent` function.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const containsWith: <A>(isEquivalent: (self: A, that: A) => boolean) => {
     (a: A): (self: Iterable<A>) => boolean;
@@ -748,7 +748,7 @@ export declare const containsWith: <A>(isEquivalent: (self: A, that: A) => boole
  * Returns a function that checks if a `ReadonlyArray` contains a given value using the default `Equivalence`.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const contains: {
     <A>(a: A): (self: Iterable<A>) => boolean;
@@ -757,7 +757,7 @@ export declare const contains: {
 /**
  * Remove duplicates from a `NonEmptyReadonlyArray`, keeping the first occurrence of an element using the provided `isEquivalent` function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dedupeNonEmptyWith: {
     <A>(isEquivalent: (self: A, that: A) => boolean): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A>;
@@ -766,7 +766,7 @@ export declare const dedupeNonEmptyWith: {
 /**
  * Remove duplicates from a `NonEmptyReadonlyArray`, keeping the first occurrence of an element.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dedupeNonEmpty: <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A>;
 /**
@@ -774,7 +774,7 @@ export declare const dedupeNonEmpty: <A>(self: NonEmptyReadonlyArray<A>) => NonE
  * `Iterable`. Typically chop is called with some function that will consume an initial prefix of the `Iterable` and produce a
  * value and the rest of the `Array`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const chop: {
     <A, B>(f: (as: NonEmptyReadonlyArray<A>) => readonly [B, ReadonlyArray<A>]): (self: Iterable<A>) => Array<B>;
@@ -785,7 +785,7 @@ export declare const chop: {
  * `NonEmptyReadonlyArray`. Typically `chop` is called with some function that will consume an initial prefix of the `NonEmptyReadonlyArray` and produce a
  * value and the tail of the `NonEmptyReadonlyArray`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const chopNonEmpty: {
     <A, B>(f: (as: NonEmptyReadonlyArray<A>) => readonly [B, ReadonlyArray<A>]): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<B>;
@@ -795,14 +795,14 @@ export declare const chopNonEmpty: {
  * Splits an `Iterable` into two pieces, the first piece has max `n` elements.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const splitAt: {
     (n: number): <A>(self: Iterable<A>) => [Array<A>, Array<A>];
     <A>(self: Iterable<A>, n: number): [Array<A>, Array<A>];
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const copy: {
     <A>(self: NonEmptyReadonlyArray<A>): NonEmptyArray<A>;
@@ -812,7 +812,7 @@ export declare const copy: {
  * Splits a `NonEmptyReadonlyArray` into two pieces, the first piece has max `n` elements.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const splitNonEmptyAt: {
     (n: number): <A>(self: NonEmptyReadonlyArray<A>) => [NonEmptyArray<A>, Array<A>];
@@ -830,7 +830,7 @@ export declare const splitNonEmptyAt: {
  * whenever `n` evenly divides the length of `self`.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const chunksOf: {
     (n: number): <A>(self: Iterable<A>) => Array<NonEmptyArray<A>>;
@@ -841,7 +841,7 @@ export declare const chunksOf: {
  * the `NonEmptyReadonlyArray`.
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const chunksOfNonEmpty: {
     (n: number): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<NonEmptyArray<A>>;
@@ -851,7 +851,7 @@ export declare const chunksOfNonEmpty: {
  * Group equal, consecutive elements of a `NonEmptyReadonlyArray` into `NonEmptyArray`s using the provided `isEquivalent` function.
  *
  * @category grouping
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const groupWith: {
     <A>(isEquivalent: (self: A, that: A) => boolean): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<NonEmptyArray<A>>;
@@ -861,7 +861,7 @@ export declare const groupWith: {
  * Group equal, consecutive elements of a `NonEmptyReadonlyArray` into `NonEmptyArray`s.
  *
  * @category grouping
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const group: <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<NonEmptyArray<A>>;
 /**
@@ -869,28 +869,28 @@ export declare const group: <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray
  * function on each element, and grouping the results according to values returned
  *
  * @category grouping
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const groupBy: {
     <A>(f: (a: A) => string): (self: Iterable<A>) => Record<string, NonEmptyArray<A>>;
     <A>(self: Iterable<A>, f: (a: A) => string): Record<string, NonEmptyArray<A>>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unionWith: <A>(isEquivalent: (self: A, that: A) => boolean) => {
     (that: Iterable<A>): (self: Iterable<A>) => A[];
     (self: Iterable<A>, that: Iterable<A>): A[];
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const union: {
     <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<A | B>;
     <A, B>(self: Iterable<A>, that: Iterable<B>): Array<A | B>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unionNonEmptyWith: <A>(isEquivalent: (self: A, that: A) => boolean) => {
     (that: readonly [A, ...A[]]): (self: readonly A[]) => [A, ...A[]];
@@ -899,7 +899,7 @@ export declare const unionNonEmptyWith: <A>(isEquivalent: (self: A, that: A) =>
     (self: readonly [A, ...A[]], that: readonly A[]): [A, ...A[]];
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unionNonEmpty: {
     <A>(that: NonEmptyReadonlyArray<A>): (self: ReadonlyArray<A>) => NonEmptyArray<A>;
@@ -911,7 +911,7 @@ export declare const unionNonEmpty: {
  * Creates an `Array` of unique values that are included in all given `Iterable`s using the provided `isEquivalent` function.
  * The order and references of result values are determined by the first `Iterable`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const intersectionWith: <A>(isEquivalent: (self: A, that: A) => boolean) => {
     (that: Iterable<A>): (self: Iterable<A>) => A[];
@@ -921,7 +921,7 @@ export declare const intersectionWith: <A>(isEquivalent: (self: A, that: A) => b
  * Creates an `Array` of unique values that are included in all given `Iterable`s.
  * The order and references of result values are determined by the first `Iterable`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const intersection: {
     <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<A & B>;
@@ -931,7 +931,7 @@ export declare const intersection: {
  * Creates a `Array` of values not included in the other given `Iterable` using the provided `isEquivalent` function.
  * The order and references of result values are determined by the first `Iterable`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const differenceWith: <A>(isEquivalent: (self: A, that: A) => boolean) => {
     (that: Iterable<A>): (self: Iterable<A>) => A[];
@@ -941,7 +941,7 @@ export declare const differenceWith: <A>(isEquivalent: (self: A, that: A) => boo
  * Creates a `Array` of values not included in the other given `Iterable` using the provided `isEquivalent` function.
  * The order and references of result values are determined by the first `Iterable`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const difference: {
     <A>(that: Iterable<A>): (self: Iterable<A>) => Array<A>;
@@ -949,19 +949,19 @@ export declare const difference: {
 };
 /**
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const empty: <A = never>() => Array<A>;
 /**
  * Constructs a new `NonEmptyArray<A>` from the specified value.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const of: <A>(a: A) => [A, ...A[]];
 /**
  * @category mapping
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const map: {
     <A, B>(f: (a: A, i: number) => B): (self: ReadonlyArray<A>) => Array<B>;
@@ -969,7 +969,7 @@ export declare const map: {
 };
 /**
  * @category mapping
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const mapNonEmpty: {
     <A, B>(f: (a: A, i: number) => B): (self: readonly [A, ...Array<A>]) => [B, ...Array<B>];
@@ -977,7 +977,7 @@ export declare const mapNonEmpty: {
 };
 /**
  * @category sequencing
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatMap: {
     <A, B>(f: (a: A, i: number) => ReadonlyArray<B>): (self: ReadonlyArray<A>) => Array<B>;
@@ -985,7 +985,7 @@ export declare const flatMap: {
 };
 /**
  * @category sequencing
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatMapNonEmpty: {
     <A, B>(f: (a: A, i: number) => NonEmptyReadonlyArray<B>): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<B>;
@@ -993,17 +993,17 @@ export declare const flatMapNonEmpty: {
 };
 /**
  * @category sequencing
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatten: <A>(self: ReadonlyArray<ReadonlyArray<A>>) => Array<A>;
 /**
  * @category sequencing
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flattenNonEmpty: <A>(self: NonEmptyReadonlyArray<NonEmptyReadonlyArray<A>>) => NonEmptyArray<A>;
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const filterMap: {
     <A, B>(f: (a: A, i: number) => Option<B>): (self: Iterable<A>) => Array<B>;
@@ -1013,7 +1013,7 @@ export declare const filterMap: {
  * Transforms all elements of the `readonlyArray` for as long as the specified function returns some value
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const filterMapWhile: {
     <A, B>(f: (a: A) => Option<B>): (self: Iterable<A>) => Array<B>;
@@ -1021,7 +1021,7 @@ export declare const filterMapWhile: {
 };
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const partitionMap: {
     <A, B, C>(f: (a: A, i: number) => Either<B, C>): (self: Iterable<A>) => [Array<B>, Array<C>];
@@ -1029,12 +1029,12 @@ export declare const partitionMap: {
 };
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const compact: <A>(self: Iterable<Option<A>>) => Array<A>;
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const filter: {
     <C extends A, B extends A, A = C>(refinement: (a: A, i: number) => a is B): (self: Iterable<C>) => Array<B>;
@@ -1044,7 +1044,7 @@ export declare const filter: {
 };
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const partition: {
     <C extends A, B extends A, A = C>(refinement: (a: A, i: number) => a is B): (self: Iterable<C>) => [Array<C>, Array<B>];
@@ -1054,12 +1054,12 @@ export declare const partition: {
 };
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const separate: <E, A>(self: Iterable<Either<E, A>>) => [Array<E>, Array<A>];
 /**
  * @category folding
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const reduce: {
     <B, A>(b: B, f: (b: B, a: A, i: number) => B): (self: Iterable<A>) => B;
@@ -1067,7 +1067,7 @@ export declare const reduce: {
 };
 /**
  * @category folding
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const reduceRight: {
     <B, A>(b: B, f: (b: B, a: A, i: number) => B): (self: Iterable<A>) => B;
@@ -1075,7 +1075,7 @@ export declare const reduceRight: {
 };
 /**
  * @category lifting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftPredicate: {
     <C extends A, B extends A, A = C>(refinement: Refinement<A, B>): (c: C) => Array<B>;
@@ -1083,22 +1083,22 @@ export declare const liftPredicate: {
 };
 /**
  * @category lifting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftOption: <A extends unknown[], B>(f: (...a: A) => Option<B>) => (...a: A) => B[];
 /**
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromNullable: <A>(a: A) => NonNullable<A>[];
 /**
  * @category lifting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftNullable: <A extends unknown[], B>(f: (...a: A) => B | null | undefined) => (...a: A) => NonNullable<B>[];
 /**
  * @category combining
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatMapNullable: {
     <A, B>(f: (a: A) => B | null | undefined): (self: ReadonlyArray<A>) => Array<NonNullable<B>>;
@@ -1106,14 +1106,14 @@ export declare const flatMapNullable: {
 };
 /**
  * @category lifting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftEither: <A extends unknown[], E, B>(f: (...a: A) => Either<E, B>) => (...a: A) => B[];
 /**
  * Check if a predicate holds true for every `ReadonlyArray` element.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const every: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: ReadonlyArray<A>) => self is ReadonlyArray<B>;
@@ -1125,28 +1125,28 @@ export declare const every: {
  * Check if a predicate holds true for some `ReadonlyArray` element.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const some: {
     <A>(predicate: Predicate<A>): <B extends A>(self: ReadonlyArray<B>) => self is NonEmptyReadonlyArray<B>;
     <B extends A, A = B>(self: ReadonlyArray<B>, predicate: Predicate<A>): self is NonEmptyReadonlyArray<B>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const extend: {
     <A, B>(f: (as: ReadonlyArray<A>) => B): (self: ReadonlyArray<A>) => Array<B>;
     <A, B>(self: ReadonlyArray<A>, f: (as: ReadonlyArray<A>) => B): Array<B>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const min: {
     <A>(O: Order.Order<A>): (self: NonEmptyReadonlyArray<A>) => A;
     <A>(self: NonEmptyReadonlyArray<A>, O: Order.Order<A>): A;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const max: {
     <A>(O: Order.Order<A>): (self: NonEmptyReadonlyArray<A>) => A;
@@ -1154,7 +1154,7 @@ export declare const max: {
 };
 /**
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unfold: <B, A>(b: B, f: (b: B) => Option<readonly [A, B]>) => A[];
 /**
@@ -1164,18 +1164,18 @@ export declare const unfold: <B, A>(b: B, f: (b: B) => Option<readonly [A, B]>)
  * It is useful when you need to compare two arrays of the same type and you have a specific way of comparing each element of the array.
  *
  * @category instances
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrder: <A>(O: Order.Order<A>) => Order.Order<ReadonlyArray<A>>;
 /**
  * @category instances
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A>) => Equivalence.Equivalence<ReadonlyArray<A>>;
 /**
  * Iterate over the `Iterable` applying `f`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const forEach: {
     <A>(f: (a: A, i: number) => void): (self: Iterable<A>) => void;
@@ -1184,7 +1184,7 @@ export declare const forEach: {
 /**
  * Remove duplicates from am `Iterable` using the provided `isEquivalent` function, keeping the first occurrence of an element.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dedupeWith: {
     <A>(isEquivalent: (self: A, that: A) => boolean): (self: Iterable<A>) => Array<A>;
@@ -1193,13 +1193,13 @@ export declare const dedupeWith: {
 /**
  * Remove duplicates from am `Iterable`, keeping the first occurrence of an element.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dedupe: <A>(self: Iterable<A>) => Array<A>;
 /**
  * Deduplicates adjacent elements that are identical using the provided `isEquivalent` function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dedupeAdjacentWith: {
     <A>(isEquivalent: (self: A, that: A) => boolean): (self: Iterable<A>) => Array<A>;
@@ -1208,13 +1208,13 @@ export declare const dedupeAdjacentWith: {
 /**
  * Deduplicates adjacent elements that are identical.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dedupeAdjacent: <A>(self: Iterable<A>) => Array<A>;
 /**
  * Joins the elements together with "sep" in the middle.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category folding
  */
 export declare const join: {
@@ -1224,7 +1224,7 @@ export declare const join: {
 /**
  * Statefully maps over the chunk, producing new elements of type `B`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category folding
  */
 export declare const mapAccum: {
@@ -1234,7 +1234,7 @@ export declare const mapAccum: {
 /**
  * Zips this chunk crosswise with the specified chunk using the specified combiner.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const cartesianWith: {
@@ -1244,7 +1244,7 @@ export declare const cartesianWith: {
 /**
  * Zips this chunk crosswise with the specified chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const cartesian: {