@daiso-tech/core 0.1.0 → 0.1.2

package/{src/contracts/collection/async-collection.contract.ts → dist/types/contracts/collection/async-collection.contract.d.ts}

@@ -1,52 +1,13 @@
-import {
-    type SliceSettings,
-    type SlidingSettings,
-    type AsyncFilter,
-    type AsyncFindOrSettings,
-    type AsyncFindSettings,
-    type AsyncForEach,
-    type AsyncGroupBySettings,
-    type AsyncLazyable,
-    type AsyncMap,
-    type AsyncModifier,
-    type AsyncReduceSettings,
-    type AsyncTap,
-    type AsyncTransform,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type CollectionError,
-    type Comparator,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type ItemNotFoundError,
-    type JoinSettings,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type MultipleItemsFoundError,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type IndexOverflowError,
-    type PageSettings,
-    type RecordItem,
-    type ReverseSettings,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    type UnexpectedCollectionError,
-    type UpdatedItem,
-} from "@/contracts/collection/_shared";
-import { type EnsureType } from "@/types";
-
+import { type SliceSettings, type SlidingSettings, type AsyncFilter, type AsyncFindOrSettings, type AsyncFindSettings, type AsyncForEach, type AsyncGroupBySettings, type AsyncLazyable, type AsyncMap, type AsyncModifier, type AsyncReduceSettings, type AsyncTap, type AsyncTransform, type Comparator, type JoinSettings, type PageSettings, type RecordItem, type ReverseSettings, type UpdatedItem } from "../../contracts/collection/_shared";
+import { type EnsureType } from "../../types";
 /**
  * @group Collections
  */
-export type AsyncIterableValue<TInput> =
-    | Iterable<TInput>
-    | AsyncIterable<TInput>;
+export type AsyncIterableValue<TInput> = Iterable<TInput> | AsyncIterable<TInput>;
 /**
  * @group Collections
  */
-export type AsyncCollapse<TValue> = TValue extends
-    | Array<infer TItem>
-    | Iterable<infer TItem>
-    | IAsyncCollection<infer TItem>
-    ? TItem
-    : TValue;
-
+export type AsyncCollapse<TValue> = TValue extends Array<infer TItem> | Iterable<infer TItem> | IAsyncCollection<infer TItem> ? TItem : TValue;
 /**
  * IAsyncCollection is immutable and all the methods return new copies
  * @throws {CollectionError}
@@ -59,15 +20,9 @@ export type AsyncCollapse<TValue> = TValue extends
  */
 export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
     iterator(): AsyncIterator<TInput, void>;
-
-    entries(
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<RecordItem<number, TInput>>;
-
+    entries(throwOnNumberLimit?: boolean): IAsyncCollection<RecordItem<number, TInput>>;
     keys(throwOnNumberLimit?: boolean): IAsyncCollection<number>;
-
     values(): IAsyncCollection<TInput>;
-
     /**
      * The filter method filters the collection using the given callback, keeping only those items that pass a given truth test:
      * @example
@@ -76,11 +31,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await filtered.toArray();
      * // [3, 4]
      */
-    filter<TOutput extends TInput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TOutput>;
-
+    filter<TOutput extends TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): IAsyncCollection<TOutput>;
     /**
      * The map method iterates through the collection and passes each value to the given callback.
      * The mapFunction is free to modify the item and return it, thus forming a new collection of modified items:
@@ -90,24 +41,12 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await mapped.toArray();
      * // [2, 4, 6, 8, 10]
      */
-    map<TOutput>(
-        map: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TOutput>;
-
-    reduce<TOutput = TInput>(
-        settings: AsyncReduceSettings<
-            TInput,
-            IAsyncCollection<TInput>,
-            TOutput
-        >,
-    ): Promise<TOutput>;
-
+    map<TOutput>(map: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): IAsyncCollection<TOutput>;
+    reduce<TOutput = TInput>(settings: AsyncReduceSettings<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput>;
     /**
      * @throws {TypeError}
      */
     join(settings?: JoinSettings): Promise<string>;
-
     /**
      * The collapse method collapses a collection of arrays into a single, flat collection:
      * @example
@@ -117,7 +56,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // [1, 2, 3, 4]
      */
     collapse(): IAsyncCollection<AsyncCollapse<TInput>>;
-
     /**
      * The flatMap method returns a new array formed by applying a given callback function to each element of the array, and then collapses the result by one level.
      * It is identical to a map() followed by a collapse()
@@ -126,15 +64,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [2, "a", "b", 2, "c", "d"]
      */
-    flatMap<TOutput>(
-        map: AsyncMap<
-            TInput,
-            IAsyncCollection<TInput>,
-            AsyncIterableValue<TOutput>
-        >,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TOutput>;
-
+    flatMap<TOutput>(map: AsyncMap<TInput, IAsyncCollection<TInput>, AsyncIterableValue<TOutput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TOutput>;
     /**
      * The update method filters the collection using the given callback, keeping only those items that pass a given truth test and thereafter updates the filtered items:
      * @example
@@ -143,12 +73,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await updateCollection.toArray();
      * // [1, 4, 3, 8, 5]
      */
-    update<TFilterOutput extends TInput, TMapOutput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TFilterOutput>,
-        map: AsyncMap<TFilterOutput, IAsyncCollection<TInput>, TMapOutput>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<UpdatedItem<TInput, TFilterOutput, TMapOutput>>;
-
+    update<TFilterOutput extends TInput, TMapOutput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TFilterOutput>, map: AsyncMap<TFilterOutput, IAsyncCollection<TInput>, TMapOutput>, throwOnNumberLimit?: boolean): IAsyncCollection<UpdatedItem<TInput, TFilterOutput, TMapOutput>>;
     /**
      * The page method returns a new collection containing the items that would be present on a given page number.
      * The method accepts the page number as its first argument and the number of items to show per page as its second argument:
@@ -162,7 +87,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // [4, 5, 6]
      */
     page(settings: PageSettings): IAsyncCollection<TInput>;
-
     /**
      * The sum method returns the sum of all items in the collection. If the collection contains nested arrays or objects,
      * you should pass a map function that returns a number to be used in sum calculation.
@@ -173,11 +97,9 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // 6
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
-     * @throws {IndexOverflowError} {@link IndexOverflowError}
      * @throws {TypeError} {@link TypeError}
      */
-    sum(throwOnNumberLimit?: boolean): Promise<EnsureType<TInput, number>>;
-
+    sum(): Promise<EnsureType<TInput, number>>;
     /**
      * The average method returns the average of all items in the collection. If the collection contains nested arrays or objects,
      * you should pass a map function that returns a number to be used in average calculation.
@@ -188,11 +110,9 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // 2
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
-     * @throws {IndexOverflowError} {@link IndexOverflowError}
      * @throws {TypeError} {@link TypeError}
      */
-    average(throwOnNumberLimit?: boolean): Promise<EnsureType<TInput, number>>;
-
+    average(): Promise<EnsureType<TInput, number>>;
     /**
      * The median method returns the median of all items in the collection. If the collection contains nested arrays or objects,
      * you should pass a map function that returns a number to be used in median calculation.
@@ -207,7 +127,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {TypeError} {@link TypeError}
      */
     median(throwOnNumberLimit?: boolean): Promise<EnsureType<TInput, number>>;
-
     /**
      * The min method returns the min of all items in the collection. If the collection contains nested arrays or objects,
      * you should pass a map function that returns a number to be used in min calculation.
@@ -221,7 +140,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {TypeError} {@link TypeError}
      */
     min(): Promise<EnsureType<TInput, number>>;
-
     /**
      * The max method returns the max of all items in the collection. If the collection contains nested arrays or objects,
      * you should pass a map function that returns a number to be used in max calculation.
@@ -235,7 +153,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {TypeError} {@link TypeError}
      */
     max(): Promise<EnsureType<TInput, number>>;
-
     /**
      * The percentage method may be used to quickly determine the percentage of items in the collection that pass a given truth test
      * @example
@@ -246,11 +163,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    percentage(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<number>;
-
+    percentage(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<number>;
     /**
      * The some method determines whether the collection has a given item.
      * You must pass a closure to the some method to determine if an element exists in the collection matching a given truth test:
@@ -262,11 +175,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    some<TOutput extends TInput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<boolean>;
-
+    some<TOutput extends TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): Promise<boolean>;
     /**
      * The every method may be used to verify that all elements of a collection pass a given truth test:
      * @example
@@ -277,11 +186,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    every<TOutput extends TInput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<boolean>;
-
+    every<TOutput extends TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): Promise<boolean>;
     /**
      * The take method returns items in the collection until the given callback returns true:
      * @example
@@ -296,7 +201,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // [4, 5]
      */
     take(limit: number, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
-
     /**
      * The takeUntil method returns items in the collection until the given callback returns true:
      * @example
@@ -305,11 +209,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await chunk.toArray();
      * // [1, 2]
      */
-    takeUntil(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput>;
-
+    takeUntil(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
     /**
      * The takeWhile method returns items in the collection until the given callback returns false:
      * @example
@@ -318,11 +218,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await chunk.toArray();
      * // [1, 2]
      */
-    takeWhile(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput>;
-
+    takeWhile(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
     /**
      * The skip method returns a new collection, with the given number of elements removed from the beginning of the collection:
      * @example
@@ -330,11 +226,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [5, 6, 7, 8, 9, 10]
      */
-    skip(
-        offset: number,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput>;
-
+    skip(offset: number, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
     /**
      * The skipUntil method skips over items from the collection until the given callback returns true
      * and then returns the remaining items in the collection as a new collection instance:
@@ -343,11 +235,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [3, 4]
      */
-    skipUntil(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput>;
-
+    skipUntil(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
     /**
      * The skipWhile method skips over items from the collection while the given callback returns false and then returns the remaining items in the collection as a new collection:
      * @example
@@ -355,11 +243,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [4]
      */
-    skipWhile(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput>;
-
+    skipWhile(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
     /**
      * The when method will execute the given callback when the first argument given to the method evaluates to true:
      * @example
@@ -369,14 +253,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1, 2, 3, 4, -3]
      */
-    when<TExtended = TInput>(
-        condition: boolean,
-        callback: AsyncModifier<
-            IAsyncCollection<TInput>,
-            IAsyncCollection<TExtended>
-        >,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    when<TExtended = TInput>(condition: boolean, callback: AsyncModifier<IAsyncCollection<TInput>, IAsyncCollection<TExtended>>): IAsyncCollection<TInput | TExtended>;
     /**
      * The whenEmpty method will execute the given callback when the collection is empty:
      * @example
@@ -390,13 +267,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1]
      */
-    whenEmpty<TExtended = TInput>(
-        callback: AsyncModifier<
-            IAsyncCollection<TInput>,
-            IAsyncCollection<TExtended>
-        >,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    whenEmpty<TExtended = TInput>(callback: AsyncModifier<IAsyncCollection<TInput>, IAsyncCollection<TExtended>>): IAsyncCollection<TInput | TExtended>;
     /**
      * The whenNot method will execute the given callback when the first argument given to the method evaluates to false:
      * @example
@@ -406,14 +277,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1, 2, 3, 4, 20]
      */
-    whenNot<TExtended = TInput>(
-        condition: boolean,
-        callback: AsyncModifier<
-            IAsyncCollection<TInput>,
-            IAsyncCollection<TExtended>
-        >,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    whenNot<TExtended = TInput>(condition: boolean, callback: AsyncModifier<IAsyncCollection<TInput>, IAsyncCollection<TExtended>>): IAsyncCollection<TInput | TExtended>;
     /**
      * The whenNotEmpty method will execute the given callback when the collection is empty:
      * @example
@@ -427,13 +291,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1, -3]
      */
-    whenNotEmpty<TExtended = TInput>(
-        callback: AsyncModifier<
-            IAsyncCollection<TInput>,
-            IAsyncCollection<TExtended>
-        >,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    whenNotEmpty<TExtended = TInput>(callback: AsyncModifier<IAsyncCollection<TInput>, IAsyncCollection<TExtended>>): IAsyncCollection<TInput | TExtended>;
     /**
      * The pipe method passes the collection to the given closure and returns the result of the executed closure:
      * @example
@@ -441,10 +299,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * const piped = await collection.pipe(collection => collection.sum());
      * // 6
      */
-    pipe<TOutput = TInput>(
-        callback: AsyncTransform<IAsyncCollection<TInput>, TOutput>,
-    ): Promise<TOutput>;
-
+    pipe<TOutput = TInput>(callback: AsyncTransform<IAsyncCollection<TInput>, TOutput>): Promise<TOutput>;
     /**
      * The tap method passes the collection to the given callback, allowing you to "tap" into the collection at a specific point
      * and do something with the items while not affecting the collection itself.The collection is then returned by the tap method:
@@ -459,7 +314,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // [1, 2, 3, 4, 5, 6]
      */
     tap(callback: AsyncTap<IAsyncCollection<TInput>>): IAsyncCollection<TInput>;
-
     /**
      * The chunk method breaks the collection into multiple, smaller collections of a given size:
      * @example
@@ -469,7 +323,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // [[1, 2, 3, 4], [5, 6, 7]]
      */
     chunk(chunkSize: number): IAsyncCollection<IAsyncCollection<TInput>>;
-
     /**
      * The chunkWhile method breaks the collection into multiple, smaller collections based on the evaluation of the given callback.
      * The chunk variable passed to the closure may be used to inspect the previous element:
@@ -481,11 +334,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await chunks.toArray();
      * //  [["A", "A"], ["B", "B"], ["C", "C", "C"], ["D"]]
      */
-    chunkWhile(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<IAsyncCollection<TInput>>;
-
+    chunkWhile(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
      * The split method breaks a collection into the given number of groups:
      * @example
@@ -494,11 +343,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await chunks.toArray();
      * // [[1, 2], [3, 4], [5]]
      */
-    split(
-        chunkAmount: number,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<IAsyncCollection<TInput>>;
-
+    split(chunkAmount: number, throwOnNumberLimit?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
      * The partition method is used to separate elements that pass a given truth test from those that do not:
      * @example
@@ -507,11 +352,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [[1, 2], [3, 4, 5, 6]]
      */
-    partition(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<IAsyncCollection<TInput>>;
-
+    partition(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
      * The sliding method returns a new collection of chunks representing a "sliding window" view of the items in the collection:
      * @experimental
@@ -520,10 +361,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [[1, 2], [2, 3], [3, 4], [4, 5]]
      */
-    sliding(
-        settings: SlidingSettings,
-    ): IAsyncCollection<IAsyncCollection<TInput>>;
-
+    sliding(settings: SlidingSettings): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
      * The groupBy method groups the collection's items by a given map function:
      * @example
@@ -539,14 +377,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      *   .map(([key, value]) => [key, await value.toArray()]).toArray();
      * // [["gmail.com", ["alice@gmail.com", "carlos@gmail.com"]], ["yahoo.com", ["bob@yahoo.com"]]]
      */
-    groupBy<TOutput = TInput>(
-        settings?: AsyncGroupBySettings<
-            TInput,
-            IAsyncCollection<TInput>,
-            TOutput
-        >,
-    ): IAsyncCollection<RecordItem<TOutput, IAsyncCollection<TInput>>>;
-
+    groupBy<TOutput = TInput>(settings?: AsyncGroupBySettings<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<RecordItem<TOutput, IAsyncCollection<TInput>>>;
     /**
      * The countBy method counts the occurrences of values in the collection.
      * By default, the method counts the occurrences of every element, allowing you to count certain "types" of elements in the collection:
@@ -559,14 +390,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * const count = await collection.countBy(item => item.split("@")[1])
      * // [["gmail.com", 2], ["yahoo.com", 1]]
      */
-    countBy<TOutput = TInput>(
-        settings?: AsyncGroupBySettings<
-            TInput,
-            IAsyncCollection<TInput>,
-            TOutput
-        >,
-    ): IAsyncCollection<RecordItem<TOutput, number>>;
-
+    countBy<TOutput = TInput>(settings?: AsyncGroupBySettings<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<RecordItem<TOutput, number>>;
     /**
      * The unique method removes all duplicate values from the collection:
      * @example
@@ -588,14 +412,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      *   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
      * ]
      */
-    unique<TOutput = TInput>(
-        settings?: AsyncGroupBySettings<
-            TInput,
-            IAsyncCollection<TInput>,
-            TOutput
-        >,
-    ): IAsyncCollection<TInput>;
-
+    unique<TOutput = TInput>(settings?: AsyncGroupBySettings<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<TInput>;
     /**
      * The diff method will return the values in the original collection that are not present in the given iterable:
      * @example
@@ -604,11 +421,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await difference.toArray();
      * // [1, 3, 5]
      */
-    difference<TOutput = TInput>(
-        iterable: AsyncIterableValue<TInput>,
-        map?: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>,
-    ): IAsyncCollection<TInput>;
-
+    difference<TOutput = TInput>(iterable: AsyncIterableValue<TInput>, map?: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<TInput>;
     /**
      * The repeat method will repat the current collection given amount
      * @example
@@ -618,7 +431,6 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // [1, 2, 3,  1, 2, 3,  1, 2, 3]
      */
     repeat(amount: number): IAsyncCollection<TInput>;
-
     /**
      * The padStart method pads this collection with another item (multiple times, if needed) until the resulting collection reaches the given length.
      * The padding is applied from the start of this collection:
@@ -635,11 +447,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * new ListCollection("abc").padStart(1, "_").join({ seperator: "" });
      * // "abc"
      */
-    padStart<TExtended = TInput>(
-        maxLength: number,
-        fillItems: AsyncIterableValue<TExtended>,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    padStart<TExtended = TInput>(maxLength: number, fillItems: AsyncIterableValue<TExtended>): IAsyncCollection<TInput | TExtended>;
     /**
      * The padEnd method pads this collection with another item (multiple times, if needed) until the resulting collection reaches the given length.
      * The padding is applied from the end of this collection:
@@ -656,17 +464,12 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * new ListCollection("abc").padEnd(1, "_").join({ seperator: "" });
      * // "abc"
      */
-    padEnd<TExtended = TInput>(
-        maxLength: number,
-        fillItems: AsyncIterableValue<TExtended>,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    padEnd<TExtended = TInput>(maxLength: number, fillItems: AsyncIterableValue<TExtended>): IAsyncCollection<TInput | TExtended>;
     /**
      * The slice is the same as Array.slice method. Se documentation on mdn:
      * @link {https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice}
      */
     slice(settings?: SliceSettings): IAsyncCollection<TInput>;
-
     /**
      * The prepend method adds items to the beginning of the collection:
      * @example
@@ -674,10 +477,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [-1, 20, 1, 2, 3, 4, 5]
      */
-    prepend<TExtended = TInput>(
-        iterable: AsyncIterableValue<TInput | TExtended>,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    prepend<TExtended = TInput>(iterable: AsyncIterableValue<TInput | TExtended>): IAsyncCollection<TInput | TExtended>;
     /**
      * The append method adds items to the end of the collection:
      * @example
@@ -685,10 +485,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1, 2, 3, 4, 5, -1, -2,]
      */
-    append<TExtended = TInput>(
-        iterable: AsyncIterableValue<TInput | TExtended>,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    append<TExtended = TInput>(iterable: AsyncIterableValue<TInput | TExtended>): IAsyncCollection<TInput | TExtended>;
     /**
      * The insertBefore method adds items before a specific filtered item:
      * @example
@@ -696,12 +493,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1, -1, 20, 2, 2, 3, 4, 5]
      */
-    insertBefore<TExtended = TInput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        iterable: AsyncIterableValue<TInput | TExtended>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    insertBefore<TExtended = TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, iterable: AsyncIterableValue<TInput | TExtended>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput | TExtended>;
     /**
      * The insertAfter method adds items after a specific filtered item:
      * @example
@@ -709,12 +501,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await collection.toArray();
      * // [1, 2, -1, 20, 2, 3, 4, 5]
      */
-    insertAfter<TExtended = TInput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        iterable: AsyncIterableValue<TInput | TExtended>,
-        throwOnNumberLimit?: boolean,
-    ): IAsyncCollection<TInput | TExtended>;
-
+    insertAfter<TExtended = TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, iterable: AsyncIterableValue<TInput | TExtended>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput | TExtended>;
     /**
      * The crossJoin method cross joins the collection's values among the given arrays or collections, returning a Cartesian product with all possible permutations:
      * @example
@@ -742,10 +529,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * //  [2, "b", "II"],
      * // ]
      */
-    crossJoin<TExtended = TInput>(
-        ...iterables: Array<AsyncIterableValue<TExtended>>
-    ): IAsyncCollection<IAsyncCollection<TInput | TExtended>>;
-
+    crossJoin<TExtended = TInput>(...iterables: Array<AsyncIterableValue<TExtended>>): IAsyncCollection<IAsyncCollection<TInput | TExtended>>;
     /**
      * The zip method merges together the values of the given array with the values of the original collection at their corresponding index:
      * @example
@@ -754,16 +538,10 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await zipped.toArray();
      * // [["Chari", 100], ["Desk", 200]]
      */
-    zip<TExtended>(
-        iterable: AsyncIterableValue<TExtended>,
-    ): IAsyncCollection<RecordItem<TInput, TExtended>>;
-
+    zip<TExtended>(iterable: AsyncIterableValue<TExtended>): IAsyncCollection<RecordItem<TInput, TExtended>>;
     sort(compare?: Comparator<TInput>): IAsyncCollection<TInput>;
-
     reverse(settings?: ReverseSettings): IAsyncCollection<TInput>;
-
     shuffle(): IAsyncCollection<TInput>;
-
     /**
      * The first method returns the first element in the collection that passes a given truth test. By default it will get the first element:
      * @example
@@ -774,25 +552,14 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      * // 3
      */
-    first<TOutput extends TInput>(
-        settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>,
-    ): Promise<TOutput | null>;
-
+    first<TOutput extends TInput>(settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput | null>;
     /**
      * The firstOr method is the same as first method but will return a provided default value if not found
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    firstOr<TOutput extends TInput, TExtended = TInput>(
-        settings: AsyncFindOrSettings<
-            TInput,
-            IAsyncCollection<TInput>,
-            TOutput,
-            TExtended
-        >,
-    ): Promise<TOutput | TExtended>;
-
+    firstOr<TOutput extends TInput, TExtended = TInput>(settings: AsyncFindOrSettings<TInput, IAsyncCollection<TInput>, TOutput, TExtended>): Promise<TOutput | TExtended>;
     /**
      * The firstOrFail method is the same as first method but will throw an Error if not found
      * @throws {CollectionError} {@link CollectionError}
@@ -800,10 +567,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    firstOrFail<TOutput extends TInput>(
-        settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>,
-    ): Promise<TOutput>;
-
+    firstOrFail<TOutput extends TInput>(settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput>;
     /**
      * The last method returns the last element in the collection that passes a given truth test. By default it will get the last element:
      * @example
@@ -814,25 +578,14 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    last<TOutput extends TInput>(
-        settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>,
-    ): Promise<TOutput | null>;
-
+    last<TOutput extends TInput>(settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput | null>;
     /**
      * The lastOr method is the same as last method but will return a provided default value if not found
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    lastOr<TOutput extends TInput, TExtended = TInput>(
-        settings: AsyncFindOrSettings<
-            TInput,
-            IAsyncCollection<TInput>,
-            TOutput,
-            TExtended
-        >,
-    ): Promise<TOutput | TExtended>;
-
+    lastOr<TOutput extends TInput, TExtended = TInput>(settings: AsyncFindOrSettings<TInput, IAsyncCollection<TInput>, TOutput, TExtended>): Promise<TOutput | TExtended>;
     /**
      * The lastOrFail method is the same as last method but will throw an Error if not found
      * @throws {CollectionError} {@link CollectionError}
@@ -840,10 +593,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    lastOrFail<TOutput extends TInput>(
-        settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>,
-    ): Promise<TOutput>;
-
+    lastOrFail<TOutput extends TInput>(settings?: AsyncFindSettings<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput>;
     /**
      * The before method is the opposite of the after method. It returns the item before the given item. null is returned if the given item is not found or is the first item:
      * @example
@@ -858,23 +608,14 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    before(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TInput | null>;
-
+    before(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput | null>;
     /**
      * The beforeOr method is the same as before method but will return a provided default value if not found
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    beforeOr<TExtended = TInput>(
-        defaultValue: AsyncLazyable<TExtended>,
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TInput | TExtended>;
-
+    beforeOr<TExtended = TInput>(defaultValue: AsyncLazyable<TExtended>, filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput | TExtended>;
     /**
      * The beforeOrFail method is the same as before method but will throw an Error if not found
      * @throws {CollectionError} {@link CollectionError}
@@ -882,11 +623,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    beforeOrFail(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TInput>;
-
+    beforeOrFail(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput>;
     /**
      * The after method returns the item after the given item. null is returned if the given item is not found or is the last item:
      * @example
@@ -901,23 +638,14 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    after(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TInput | null>;
-
+    after(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput | null>;
     /**
      * The afterOr method is the same as after method but will return a provided default value if not found
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    afterOr<TExtended = TInput>(
-        defaultValue: AsyncLazyable<TExtended>,
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TInput | TExtended>;
-
+    afterOr<TExtended = TInput>(defaultValue: AsyncLazyable<TExtended>, filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput | TExtended>;
     /**
      * The afterOrFail method is the same as after method but will throw an Error if not found
      * @throws {CollectionError} {@link CollectionError}
@@ -925,11 +653,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    afterOrFail(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TInput>;
-
+    afterOrFail(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput>;
     /**
      * The sole method returns the first element in the collection that passes a given truth test, but only if the truth test matches exactly one element:
      * @example
@@ -942,11 +666,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {MultipleItemsFoundError} {@link MultipleItemsFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    sole<TOutput extends TInput>(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<TOutput>;
-
+    sole<TOutput extends TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): Promise<TOutput>;
     /**
      * The nth method creates a new collection consisting of every n-th element:
      * @example
@@ -955,13 +675,36 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * // ["a", "e"]
      */
     nth(step: number): IAsyncCollection<TInput>;
-
+    /**
+     * The delay method will delay collection such that each value is returned after the specified number of seconds.
+     * This method is especially useful for situations where you may be interacting with external APIs that rate limit incoming requests:
+     * @example
+     * // An iterator that will fetch all users from a specific api
+     * class ApiIterator implements AsyncIterable<IUser> { ... }
+     * const apiIterator = new ApiIterator();
+     * const collection = new AsyncIterableCollection(apiIterator);
+     * await collection.delay(1000).forEach(user => console.log(user))
+     */
     delay(timeInMs: number): IAsyncCollection<TInput>;
-
     abort(signal: AbortSignal): IAsyncCollection<TInput>;
-
+    /**
+     * The timeout method returns a new collection that will iterate values until the specified time.
+     * After that time, the collection will then stop iterating:
+     * @example
+     * class AsyncInfiniteIterable implements AsyncIterable<number> {
+     *  async *[Symbol.asyncIterator]() {
+     *      while(true) {
+     *          yield 1;
+     *      }
+     *  }
+     * }
+     * const asyncInfiniteIterable = new AsyncInfiniteIterable();
+     * const collection = new AsyncIterableCollection(asyncInfiniteIterable);
+     * collection
+     *  .timeout(1000)
+     *  .forEach(nbr => console.log(nbr))
+     */
     timeout(timeInMs: number): IAsyncCollection<TInput>;
-
     /**
      * The count method returns the total number of items in the collection:
      * @example
@@ -972,53 +715,38 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    count(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<number>;
-
+    count(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<number>;
     /**
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
     size(throwOnNumberLimit?: boolean): Promise<number>;
-
     /**
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
     empty(): Promise<boolean>;
-
     /**
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
     notEmpty(): Promise<boolean>;
-
     /**
      * The search method searches the collection for the given value and returns its index if found. If the item is not found, -1 is returned:
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    search(
-        filter: AsyncFilter<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<number>;
-
+    search(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<number>;
     /**
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    forEach(
-        callback: AsyncForEach<TInput, IAsyncCollection<TInput>>,
-        throwOnNumberLimit?: boolean,
-    ): Promise<void>;
-
+    forEach(callback: AsyncForEach<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<void>;
     /**
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}