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

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

@@ -1,5 +1,5 @@
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 import type { Either } from "./Either.js";
 import * as Equal from "./Equal.js";
@@ -14,12 +14,12 @@ import type { Predicate, Refinement } from "./Predicate.js";
 declare const TypeId: unique symbol;
 /**
  * @category symbol
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type TypeId = typeof TypeId;
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface Chunk<A> extends Iterable<A>, Equal.Equal, Pipeable, Inspectable {
     readonly [TypeId]: {
@@ -29,13 +29,13 @@ export interface Chunk<A> extends Iterable<A>, Equal.Equal, Pipeable, Inspectabl
 }
 /**
  * @category model
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface NonEmptyChunk<A> extends Chunk<A>, NonEmptyIterable<A> {
 }
 /**
  * @category type lambdas
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface ChunkTypeLambda extends TypeLambda {
     readonly type: Chunk<this["Target"]>;
@@ -44,14 +44,14 @@ export interface ChunkTypeLambda extends TypeLambda {
  * Compares the two chunks of equal length using the specified function
  *
  * @category equivalence
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A>) => Equivalence.Equivalence<Chunk<A>>;
 /**
  * Checks if `u` is a `Chunk<unknown>`
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isChunk: {
     <A>(u: Iterable<A>): u is Chunk<A>;
@@ -59,39 +59,39 @@ export declare const isChunk: {
 };
 /**
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const empty: <A = never>() => Chunk<A>;
 /**
  * Builds a `NonEmptyChunk` from an non-empty collection of elements.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const make: <As extends readonly [any, ...any[]]>(...as: As) => NonEmptyChunk<As[number]>;
 /**
  * Builds a `NonEmptyChunk` from a single element.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const of: <A>(a: A) => NonEmptyChunk<A>;
 /**
  * Converts from an `Iterable<A>`
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromIterable: <A>(self: Iterable<A>) => Chunk<A>;
 /**
  * Converts the specified `Chunk` to a `ReadonlyArray`.
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toReadonlyArray: <A>(self: Chunk<A>) => readonly A[];
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const reverse: <A>(self: Chunk<A>) => Chunk<A>;
@@ -99,7 +99,7 @@ export declare const reverse: <A>(self: Chunk<A>) => Chunk<A>;
  * This function provides a safe way to read a value at a particular index from a `Chunk`.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const get: {
     (index: number): <A>(self: Chunk<A>) => Option<A>;
@@ -108,21 +108,21 @@ export declare const get: {
 /**
  * Wraps an array into a chunk without copying, unsafe on mutable arrays
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category unsafe
  */
 export declare const unsafeFromArray: <A>(self: readonly A[]) => Chunk<A>;
 /**
  * Wraps an array into a chunk without copying, unsafe on mutable arrays
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category unsafe
  */
 export declare const unsafeFromNonEmptyArray: <A>(self: readonly [A, ...A[]]) => NonEmptyChunk<A>;
 /**
  * Gets an element unsafely, will throw on out of bounds
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category unsafe
  */
 export declare const unsafeGet: {
@@ -133,7 +133,7 @@ export declare const unsafeGet: {
  * Appends the specified element to the end of the `Chunk`.
  *
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const append: {
     <A2>(a: A2): <A>(self: Chunk<A>) => NonEmptyChunk<A2 | A>;
@@ -143,7 +143,7 @@ export declare const append: {
  * Prepend an element to the front of a `Chunk`, creating a new `NonEmptyChunk`.
  *
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const prepend: {
     <B>(elem: B): <A>(self: Chunk<A>) => NonEmptyChunk<B | A>;
@@ -152,7 +152,7 @@ export declare const prepend: {
 /**
  * Takes the first up to `n` elements from the chunk
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const take: {
     (n: number): <A>(self: Chunk<A>) => Chunk<A>;
@@ -161,7 +161,7 @@ export declare const take: {
 /**
  * Drops the first up to `n` elements from the chunk
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const drop: {
     (n: number): <A>(self: Chunk<A>) => Chunk<A>;
@@ -170,7 +170,7 @@ export declare const drop: {
 /**
  * Drops the last `n` elements.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dropRight: {
     (n: number): <A>(self: Chunk<A>) => Chunk<A>;
@@ -179,7 +179,7 @@ export declare const dropRight: {
 /**
  * Drops all elements so long as the predicate returns true.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const dropWhile: {
     <A>(f: (a: A) => boolean): (self: Chunk<A>) => Chunk<A>;
@@ -187,7 +187,7 @@ export declare const dropWhile: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const prependAll: {
     <B>(that: Chunk<B>): <A>(self: Chunk<A>) => Chunk<B | A>;
@@ -195,7 +195,7 @@ export declare const prependAll: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const prependAllNonEmpty: {
     <B>(that: NonEmptyChunk<B>): <A>(self: Chunk<A>) => NonEmptyChunk<B | A>;
@@ -207,7 +207,7 @@ export declare const prependAllNonEmpty: {
  * Concatenates the two chunks
  *
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const appendAll: {
     <B>(that: Chunk<B>): <A>(self: Chunk<A>) => Chunk<B | A>;
@@ -215,7 +215,7 @@ export declare const appendAll: {
 };
 /**
  * @category concatenating
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const appendAllNonEmpty: {
     <B>(that: NonEmptyChunk<B>): <A>(self: Chunk<A>) => NonEmptyChunk<B | A>;
@@ -226,7 +226,7 @@ export declare const appendAllNonEmpty: {
 /**
  * Returns a filtered and mapped subset of the elements.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category filtering
  */
 export declare const filterMap: {
@@ -236,7 +236,7 @@ export declare const filterMap: {
 /**
  * Returns a filtered and mapped subset of the elements.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category filtering
  */
 export declare const filter: {
@@ -248,7 +248,7 @@ export declare const filter: {
 /**
  * Transforms all elements of the chunk for as long as the specified function returns some value
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category filtering
  */
 export declare const filterMapWhile: {
@@ -258,14 +258,14 @@ export declare const filterMapWhile: {
 /**
  * Filter out optional values
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category filtering
  */
 export declare const compact: <A>(self: Chunk<Option<A>>) => Chunk<A>;
 /**
  * Returns a chunk with the elements mapped by the specified function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const flatMap: {
@@ -274,7 +274,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) => NonEmptyChunk<B>): (self: NonEmptyChunk<A>) => NonEmptyChunk<B>;
@@ -283,7 +283,7 @@ export declare const flatMapNonEmpty: {
 /**
  * Applies the specified function to each element of the `List`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category combinators
  */
 export declare const forEach: {
@@ -293,19 +293,19 @@ export declare const forEach: {
 /**
  * Flattens a chunk of chunks into a single chunk by concatenating all chunks.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const flatten: <A>(self: Chunk<Chunk<A>>) => Chunk<A>;
 /**
  * @category sequencing
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flattenNonEmpty: <A>(self: NonEmptyChunk<NonEmptyChunk<A>>) => NonEmptyChunk<A>;
 /**
  * Groups elements in chunks of up to `n` elements.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const chunksOf: {
@@ -317,7 +317,7 @@ export declare const chunksOf: {
  *
  * The order and references of result values are determined by the Chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const intersection: {
@@ -327,56 +327,56 @@ export declare const intersection: {
 /**
  * Determines if the chunk is empty.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const isEmpty: <A>(self: Chunk<A>) => boolean;
 /**
  * Determines if the chunk is not empty.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const isNonEmpty: <A>(self: Chunk<A>) => self is NonEmptyChunk<A>;
 /**
  * Returns the first element of this chunk if it exists.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const head: <A>(self: Chunk<A>) => Option<A>;
 /**
  * Returns the first element of this chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category unsafe
  */
 export declare const unsafeHead: <A>(self: Chunk<A>) => A;
 /**
  * Returns the first element of this non empty chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const headNonEmpty: <A>(self: NonEmptyChunk<A>) => A;
 /**
  * Returns the last element of this chunk if it exists.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const last: <A>(self: Chunk<A>) => Option<A>;
 /**
  * Returns the last element of this chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category unsafe
  */
 export declare const unsafeLast: <A>(self: Chunk<A>) => A;
 /**
  * Returns an effect whose success is mapped by the specified f function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category mapping
  */
 export declare const map: {
@@ -386,7 +386,7 @@ export declare const map: {
 /**
  * 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: {
@@ -397,7 +397,7 @@ export declare const mapAccum: {
  * Separate elements based on a predicate that also exposes the index of the element.
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const partition: {
     <C extends A, B extends A, A = C>(refinement: Refinement<A, B>): (self: Chunk<C>) => [Chunk<Exclude<C, B>>, Chunk<B>];
@@ -409,7 +409,7 @@ export declare const partition: {
  * Partitions the elements of this chunk into two chunks using f.
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const partitionMap: {
     <A, B, C>(f: (a: A) => Either<B, C>): (self: Chunk<A>) => [Chunk<B>, Chunk<C>];
@@ -419,20 +419,20 @@ export declare const partitionMap: {
  * Partitions the elements of this chunk into two chunks.
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const separate: <A, B>(self: Chunk<Either<A, B>>) => [Chunk<A>, Chunk<B>];
 /**
  * Retireves the size of the chunk
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const size: <A>(self: Chunk<A>) => number;
 /**
  * Sort the elements of a Chunk in increasing order, creating a new Chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const sort: {
@@ -440,7 +440,7 @@ export declare const sort: {
     <A extends B, B>(self: Chunk<A>, O: Order.Order<B>): Chunk<A>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const sortWith: {
@@ -450,7 +450,7 @@ export declare const sortWith: {
 /**
  *  Returns two splits of this chunk at the specified index.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const splitAt: {
@@ -460,7 +460,7 @@ export declare const splitAt: {
 /**
  * Splits this chunk into `n` equally sized chunks.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const split: {
@@ -471,7 +471,7 @@ export declare const split: {
  * Splits this chunk on the first element that matches this predicate.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const splitWhere: {
     <A>(predicate: Predicate<A>): (self: Chunk<A>) => [Chunk<A>, Chunk<A>];
@@ -480,21 +480,21 @@ export declare const splitWhere: {
 /**
  * Returns every elements after the first.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const tail: <A>(self: Chunk<A>) => Option<Chunk<A>>;
 /**
  * Returns every elements after the first.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const tailNonEmpty: <A>(self: NonEmptyChunk<A>) => Chunk<A>;
 /**
  * Takes the last `n` elements.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const takeRight: {
@@ -504,7 +504,7 @@ export declare const takeRight: {
 /**
  * Takes all elements so long as the predicate returns true.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const takeWhile: {
@@ -514,7 +514,7 @@ export declare const takeWhile: {
 /**
  * Creates a Chunks of unique values, in order, from all given Chunks.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const union: {
@@ -524,14 +524,14 @@ export declare const union: {
 /**
  * Remove duplicates from an array, keeping the first occurrence of an element.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const dedupe: <A>(self: Chunk<A>) => Chunk<A>;
 /**
  * Deduplicates adjacent elements that are identical.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category filtering
  */
 export declare const dedupeAdjacent: <A>(self: Chunk<A>) => Chunk<A>;
@@ -540,14 +540,14 @@ export declare const dedupeAdjacent: <A>(self: Chunk<A>) => Chunk<A>;
  *
  * Note: The function is reverse of `zip`.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const unzip: <A, B>(self: Chunk<readonly [A, B]>) => [Chunk<A>, Chunk<B>];
 /**
  * Zips this chunk pointwise with the specified chunk using the specified combiner.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const zipWith: {
@@ -557,7 +557,7 @@ export declare const zipWith: {
 /**
  * Zips this chunk pointwise with the specified chunk.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category elements
  */
 export declare const zip: {
@@ -568,14 +568,14 @@ export declare const zip: {
  * Delete the element at the specified index, creating a new `Chunk`,
  * or returning 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: Chunk<A>) => Chunk<A>;
     <A>(self: Chunk<A>, i: number): Chunk<A>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const modifyOption: {
     <A, B>(i: number, f: (a: A) => B): (self: Chunk<A>) => Option<Chunk<A | B>>;
@@ -585,7 +585,7 @@ export declare const modifyOption: {
  * Apply a function to the element at the specified index, creating a new `Chunk`,
  * or returning 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: Chunk<A>) => Chunk<A | B>;
@@ -595,14 +595,14 @@ export declare const modify: {
  * Change the element at the specified index, creating a new `Chunk`,
  * or returning 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: Chunk<A>) => Chunk<B | A>;
     <A, B>(self: Chunk<A>, i: number, b: B): Chunk<B | A>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const replaceOption: {
     <B>(i: number, b: B): <A>(self: Chunk<A>) => Option<Chunk<B | A>>;
@@ -614,7 +614,7 @@ export declare const replaceOption: {
  * **Note**. `n` is normalized to an integer >= 1.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const makeBy: {
     <A>(f: (i: number) => A): (n: number) => NonEmptyChunk<A>;
@@ -624,14 +624,14 @@ export declare const makeBy: {
  * Create a non empty `Chunk` containing a range of integers, including both endpoints.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const range: (start: number, end: number) => NonEmptyChunk<number>;
 /**
  * Returns a function that checks if a `Chunk` 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: Chunk<A>) => boolean;
@@ -641,7 +641,7 @@ export declare const contains: {
  * Returns a function that checks if a `Chunk` 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: Chunk<A>) => boolean;
@@ -652,7 +652,7 @@ export declare const containsWith: <A>(isEquivalent: (self: A, that: A) => boole
  * 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: Chunk<A>) => Option<B>;
@@ -664,7 +664,7 @@ export declare const findFirst: {
  * 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: Chunk<A>) => Option<number>;
@@ -674,7 +674,7 @@ export declare const findFirstIndex: {
  * 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: Chunk<A>) => Option<B>;
@@ -686,7 +686,7 @@ export declare const findLast: {
  * 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: Chunk<A>) => Option<number>;
@@ -696,7 +696,7 @@ export declare const findLastIndex: {
  * Check if a predicate holds true for every `Chunk` element.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const every: {
     <A, B extends A>(refinement: Refinement<A, B>): (self: Chunk<A>) => self is Chunk<B>;
@@ -708,7 +708,7 @@ export declare const every: {
  * Check if a predicate holds true for some `Chunk` element.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const some: {
     <A>(predicate: Predicate<A>): <B extends A>(self: Chunk<B>) => self is NonEmptyChunk<B>;
@@ -718,7 +718,7 @@ export declare const some: {
  * Joins the elements together with "sep" in the middle.
  *
  * @category folding
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const join: {
     (sep: string): (self: Chunk<string>) => string;
@@ -726,7 +726,7 @@ export declare const join: {
 };
 /**
  * @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: Chunk<A>) => B;
@@ -734,7 +734,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: Chunk<A>) => B;