@daiso-tech/core 0.1.2 → 0.1.3

package/dist/types/contracts/collection/async-collection.contract.d.ts

@@ -1,54 +1,103 @@
-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
+ * @module Collections
  */
+import { type SliceSettings, type SlidingSettings, type AsyncPredicate, type AsyncFindOrSettings, type AsyncFindSettings, type AsyncForEach, type AsyncGroupBySettings, type AsyncCountBySettings, type AsyncUniqueSettings, 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 "../../_shared/types";
 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;
 /**
- * IAsyncCollection is immutable and all the methods return new copies
+ * <i>IAsyncCollection</i> is immutable. The <i>throwOnIndexOverflow</i> parameter in the <i>ICollection</i> methods is used for preventing the index to overflow by throwing an error.
  * @throws {CollectionError}
  * @throws {UnexpectedCollectionError}
  * @throws {IndexOverflowError}
  * @throws {ItemNotFoundError}
  * @throws {MultipleItemsFoundError}
  * @throws {TypeError}
- * @group Collections
+ * @group Contracts
  */
 export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
-    iterator(): AsyncIterator<TInput, void>;
-    entries(throwOnNumberLimit?: boolean): IAsyncCollection<RecordItem<number, TInput>>;
-    keys(throwOnNumberLimit?: boolean): IAsyncCollection<number>;
+    /**
+     * The <i>toIterator</i> method converts the collection to a new iterator.
+     */
+    toIterator(): AsyncIterator<TInput, void>;
+    /**
+     * The <i>entries</i> returns an IAsyncCollection of key, value pairs for every entry in the collection.
+     */
+    entries(throwOnIndexOverflow?: boolean): IAsyncCollection<RecordItem<number, TInput>>;
+    /**
+     * The <i>keys</i> method returns an IAsyncCollection of keys in the collection.
+     */
+    keys(throwOnIndexOverflow?: boolean): IAsyncCollection<number>;
+    /**
+     * The <i>values</i> method returns a copy of the collection.
+     */
     values(): IAsyncCollection<TInput>;
     /**
-     * The filter method filters the collection using the given callback, keeping only those items that pass a given truth test:
+     * The <i>filter</i> method filters the collection using <i>predicateFn</i>, keeping only those items that pass <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6]);
      * const filtered = collection.filter(item => 2 < item && item < 5);
      * await filtered.toArray();
      * // [3, 4]
      */
-    filter<TOutput extends TInput>(filter: AsyncFilter<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): IAsyncCollection<TOutput>;
+    filter<TOutput extends TInput>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>, TOutput>, throwOnIndexOverflow?: 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:
+     * The <i>reject</i> method filters the collection using <i>predicateFn</i>, keeping only those items that not pass <i>predicateFn</i>.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6]);
+     * const filtered = collection.reject(item => 2 < item && item < 5);
+     * await filtered.toArray();
+     * // [1, 2, 5, 6]
+     */
+    reject<TOutput extends TInput>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): IAsyncCollection<Exclude<TInput, TOutput>>;
+    /**
+     * The <i>map</i> method iterates through the collection and passes each item to <i>mapFn</i>.
+     * The <i>mapFn</i> is free to modify the item and return it, thus forming a new collection of modified items.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]);
      * const mapped = collection.map(item => item * 2);
      * await mapped.toArray();
      * // [2, 4, 6, 8, 10]
      */
-    map<TOutput>(map: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): IAsyncCollection<TOutput>;
+    map<TOutput>(mapFn: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): IAsyncCollection<TOutput>;
+    /**
+     * The <i>reduce</i> method executes <i> {@link ReduceSettings | ReduceSettings.reduceFn} </i> function on each item of the array, passing in the return value from the calculation on the preceding item.
+     * The final result of running the reducer across all items of the array is a single value.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3]);
+     * await collection.reduce({
+     *   reduceFn: (sum, item) => sum + item
+     * });
+     * // 6
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c"]);
+     * await collection.entries().reduce({
+     *   reduceFn: (record, [key, value]) => ({
+     *     ...record,
+     *     [key]: value
+     *   }),
+     *   initialValue: {} as Record<number, string>
+     * });
+     * // { 0: "a", 1: "b", 2: "c" }
+     */
     reduce<TOutput = TInput>(settings: AsyncReduceSettings<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput>;
     /**
+     * The <i>join</i> method joins the collection's items with {@link JoinSettings | JoinSettings.seperator}. An error will be thrown when if a none string item is encounterd.
      * @throws {TypeError}
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.map(item => item.toString()).join();
+     * // "1,2,3,4"
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.map(item => item.toString()).join({
+     *   seperator: "_"
+     * });
+     * // "1_2_3_4"
      */
-    join(settings?: JoinSettings): Promise<string>;
+    join(settings?: JoinSettings): Promise<EnsureType<TInput, string>>;
     /**
-     * The collapse method collapses a collection of arrays into a single, flat collection:
+     * The <i>collapse</i> method collapses a collection of iterables into a single, flat collection.
      * @example
      * const collection = new AsyncIterableCollection([[1, 2], [3, 4]]);
      * const collapsed = collection.collapse();
@@ -57,40 +106,37 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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()
+     * The <i>flatMap</i> method returns a new array formed by applying <i>mapFn</i> to each item of the array, and then collapses the result by one level.
+     * It is identical to a <i>map</i> method followed by a <i>collapse</i> method.
      * @example
      * const collection = new AsyncIterableCollection([["a", "b"], ["c", "d"]]).flatMap(item => [item.length, ...item]);
      * await collection.toArray();
      * // [2, "a", "b", 2, "c", "d"]
      */
-    flatMap<TOutput>(map: AsyncMap<TInput, IAsyncCollection<TInput>, AsyncIterableValue<TOutput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TOutput>;
+    flatMap<TOutput>(mapFn: AsyncMap<TInput, IAsyncCollection<TInput>, Iterable<TOutput>>, throwOnIndexOverflow?: 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:
+     * The <i>update</i> method updates only the items that passes <i>predicateFn</i> using <i>mapFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]);
      * const updateCollection = collection.update(item => item % 2 === 0, item => item * 2);
      * 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>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>, TFilterOutput>, mapFn: AsyncMap<TFilterOutput, IAsyncCollection<TInput>, TMapOutput>, throwOnIndexOverflow?: 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:
+     * The <i>page</i> method returns a new collection containing the items that would be present on <i>{@link PageSettings | PageSettings.page}</i> with custom <i>{@link PageSettings | PageSettings.pageSize}</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6, 7, 8, 9]);
      * const page = collection.page({
-     *  page: 2,
-     *  pageSize: 3
+     *   page: 2,
+     *   pageSize: 3
      * });
      * await page.toArray();
      * // [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.
-     * You can only pass filter to filter out the items you want:
+     * The <i>sum</i> method returns the sum of all items in the collection. If the collection includes other than number items an error will be thrown.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3]);
      * await collection.sum();
@@ -101,9 +147,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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.
-     * You can only pass filter to filter out the items you want:
+     * The <i>average</i> method returns the average of all items in the collection. If the collection includes other than number items an error will be thrown.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3]);
      * await collection.average();
@@ -114,9 +158,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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.
-     * You can only pass filter to filter out the items you want:
+     * The <i>median</i> method returns the median of all items in the collection. If the collection includes other than number items an error will be thrown.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3]);
      * await collection.median();
@@ -126,11 +168,9 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      * @throws {TypeError} {@link TypeError}
      */
-    median(throwOnNumberLimit?: boolean): Promise<EnsureType<TInput, number>>;
+    median(throwOnIndexOverflow?: 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.
-     * You can only pass filter to filter out the items you want:
+     * The <i>min</i> method returns the min of all items in the collection. If the collection includes other than number items an error will be thrown.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3]);
      * await collection.min();
@@ -141,9 +181,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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.
-     * You can only pass filter to filter out the items you want:
+     * The <i>max</i> method returns the max of all items in the collection. If the collection includes other than number items an error will be thrown.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3]);
      * await collection.max();
@@ -154,7 +192,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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
+     * The <i>percentage</i> method may be used to quickly determine the percentage of items in the collection that pass <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 1, 2, 2, 2, 3]);
      * await collection.percentage(value => value === 1);
@@ -163,10 +201,9 @@ 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(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: 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:
+     * The <i>some</i> method determines whether at least one item in the collection matches <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([0, 1, 2, 3, 4, 5]);
      * await collection.some(item => item === 1);
@@ -175,9 +212,9 @@ 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>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): Promise<boolean>;
     /**
-     * The every method may be used to verify that all elements of a collection pass a given truth test:
+     * The <i>every</i> method determines whether all items in the collection matches <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([0, 1, 2, 3, 4, 5]);
      * await collection.every(item => item < 6);
@@ -186,9 +223,9 @@ 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>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): Promise<boolean>;
     /**
-     * The take method returns items in the collection until the given callback returns true:
+     * The <i>take</i> method takes the first <i>limit</i> items.
      * @example
      * const collection = new AsyncIterableCollection([0, 1, 2, 3, 4, 5]);
      * const chunk = collection.take(3);
@@ -200,52 +237,51 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      * await chunk.toArray();
      * // [4, 5]
      */
-    take(limit: number, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
+    take(limit: number, throwOnIndexOverflow?: boolean): IAsyncCollection<TInput>;
     /**
-     * The takeUntil method returns items in the collection until the given callback returns true:
+     * The <i>takeUntil</i> method takes items until <i>predicateFn</i> returns true.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
      * const chunk = collection.takeUntil(item => item >= 3);
      * await chunk.toArray();
      * // [1, 2]
      */
-    takeUntil(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
+    takeUntil(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): IAsyncCollection<TInput>;
     /**
-     * The takeWhile method returns items in the collection until the given callback returns false:
+     * The <i>takeWhile</i> method takes items until <i>predicateFn</i> returns false.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
-     * const chunk = collection.takeWhile(item => item < 3);
+     * const chunk = collection.takeWhile(item => item < 4);
      * await chunk.toArray();
-     * // [1, 2]
+     * // [1, 2, 3]
      */
-    takeWhile(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
+    takeWhile(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): IAsyncCollection<TInput>;
     /**
-     * The skip method returns a new collection, with the given number of elements removed from the beginning of the collection:
+     * The <i>skip</i> method skips the first <i>offset</i> items.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]).skip(4);
      * await collection.toArray();
      * // [5, 6, 7, 8, 9, 10]
      */
-    skip(offset: number, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
+    skip(offset: number, throwOnIndexOverflow?: 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:
+     * The <i>skipUntil</i> method skips items until <i>predicateFn</i> returns true.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]).skipUntil(item => item >= 3);
      * await collection.toArray();
      * // [3, 4]
      */
-    skipUntil(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
+    skipUntil(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: 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:
+     * The <i>skipWhile</i> method skips items until <i>predicateFn</i> returns false.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]).skipWhile(item => item <= 3);
      * await collection.toArray();
      * // [4]
      */
-    skipWhile(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<TInput>;
+    skipWhile(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): IAsyncCollection<TInput>;
     /**
-     * The when method will execute the given callback when the first argument given to the method evaluates to true:
+     * The <i>when</i> method will execute <i>callback</i> when <i>condition</i> evaluates to true.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4])
      *  .when(true, collection => collection.append([-3]))
@@ -255,7 +291,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>whenEmpty</i> method will execute <i>callback</i> when the collection is empty.
      * @example
      * const collection = new AsyncIterableCollection([])
      *  .whenEmpty(collection => collection.append([-3]))
@@ -269,7 +305,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>whenNot</i> method will execute <i>callback</i> when <i>condition</i> evaluates to false.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4])
      *  .whenNot(true, collection => collection.append([-3]))
@@ -279,7 +315,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>whenNotEmpty</i> method will execute <i>callback</i> when the collection is not empty.
      * @example
      * const collection = new AsyncIterableCollection([])
      *  .whenNotEmpty(collection => collection.append([-3]))
@@ -293,29 +329,40 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>pipe</i> method passes the orignal collection to <i>callback</i> and returns the result from <i>callback</i>.
+     * This method is useful when you want compose multiple smaller functions.
      * @example
-     * const collection = new AsyncIterableCollection([1, 2, 3]);
-     * const piped = await collection.pipe(collection => collection.sum());
-     * // 6
+     * const collection = new AsyncIterableCollection([1, "2", "a", 1, 3, {}]);
+     *
+     * function toNbrs<TInput>(collection: IAsyncCollection<TInput>): IAsyncCollection<number> {
+     *   return collection.map(item => Number(item)).reject(nbr => Number.isNaN(nbr)))
+     * }
+     * function nbrToStr(collection: IAsyncCollection<number>): IAsyncCollection<string> {
+     *   return collection.map(nbr => String.fromCharCode(nbr)).repeat(2).join("_")
+     * }
+     *
+     * const piped = await collection
+     *   .pipe(toNbrs)
+     *   .then(nbrToStr);
+     * // "\x01_\x02_\x01_\x03_\x01_\x02_\x01_\x03"
      */
     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:
+     * The <i>tap</i> method passes a copy of the original collection to <i>callback</i>, allowing you to do something with the items while not affecting the original collection.
      * @example
-     * const collection = await new AsyncIterableCollection([1, 2, 3, 4, 5, 6])
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6])
      *   .tap(collection => {
      *     collection
      *       .filter(value => value % 2 === 0)
      *       .forEach(value => console.log(value))
-     *   })
-     *   .toArray();
+     *   });
+     * await collection.toArray();
      * // [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:
+     * The <i>chunk</i> method breaks the collection into multiple, smaller collections of size <i>chunkSize</i>.
+     * If <i>chunkSize</i> is not divisible with total number of items then the last chunk will contain the remaining items.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6, 7]);
      * const chunks = collection.chunk(4);
@@ -324,38 +371,47 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>chunkWhile</i> method breaks the collection into multiple, smaller collections based on the evaluation of <i>predicateFn</i>.
+     * The chunk variable passed to the <i>predicateFn</i> may be used to inspect the previous item.
      * @example
-     * const collection = new AsyncIterableCollection("AABBCCCD".split(""));
+     * const collection = new AsyncIterableCollection("AABBCCCD");
      * const chunks = collection.chunkWhile((value, index, chunk) => {
      *  return value === chunk.last();
      * });
      * await chunks.toArray();
      * //  [["A", "A"], ["B", "B"], ["C", "C", "C"], ["D"]]
      */
-    chunkWhile(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
+    chunkWhile(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
-     * The split method breaks a collection into the given number of groups:
+     * The <i>split</i> method breaks a collection evenly into <i>chunkAmount</i> of chunks.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]);
      * const chunks = collection.split(3);
      * await chunks.toArray();
      * // [[1, 2], [3, 4], [5]]
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6]);
+     * const chunks = collection.split(3);
+     * await chunks.toArray();
+     * // [[1, 2], [3, 4], [5, 6]]
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6, 7]);
+     * const chunks = collection.split(3);
+     * await chunks.toArray();
+     * // [[1, 2, 7], [3, 4], [5, 6]]
      */
-    split(chunkAmount: number, throwOnNumberLimit?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
+    split(chunkAmount: number, throwOnIndexOverflow?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
-     * The partition method is used to separate elements that pass a given truth test from those that do not:
+     * The <i>partition</i> method is used to separate items that pass <i>predicateFn</i> from those that do not.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6]);
      * collection.partition(item => item < 3);
      * await collection.toArray();
      * // [[1, 2], [3, 4, 5, 6]]
      */
-    partition(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): IAsyncCollection<IAsyncCollection<TInput>>;
+    partition(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: 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
+     * The <i>sliding</i> method returns a new collection of chunks representing a "sliding window" view of the items in the collection.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]).sliding(2);
      * await collection.toArray();
@@ -363,36 +419,79 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     sliding(settings: SlidingSettings): IAsyncCollection<IAsyncCollection<TInput>>;
     /**
-     * The groupBy method groups the collection's items by a given map function:
+     * The <i>groupBy</i> method groups the collection's items by {@link GroupBySettings | GroupBySettings.selectFn}.
+     * By default the equality check occurs on the item.
      * @example
      * const collection = new AsyncIterableCollection(["a", "a", "a", "b", "b", "c"]);
      * const group = await collection
      *   .groupBy()
-     *   .map(async ([key, value]) => [key, await  value.toArray()]).toArray();
-     * // [["a", ["a", "a", "a"]], ["b", ["b", "b", "b"]], ["c", ["c"]]]
+     *   .map(([key, collection]) => [key, collection.toArray()])
+     *   .toArray();
+     * // [
+     * //  [
+     * //    "a",
+     * //    ["a", "a", "a"]
+     * //  ],
+     * //  [
+     * //    "b",
+     * //    ["b", "b"]
+     * //  ],
+     * //  [
+     * //    "c",
+     * //    ["c"]
+     * //  ]
+     * // ]
      * @example
      * const collection = new AsyncIterableCollection(["alice@gmail.com", "bob@yahoo.com", "carlos@gmail.com"]);
      * const group = await collection
-     *   .groupBy(item => item.split("@")[1])
-     *   .map(([key, value]) => [key, await value.toArray()]).toArray();
-     * // [["gmail.com", ["alice@gmail.com", "carlos@gmail.com"]], ["yahoo.com", ["bob@yahoo.com"]]]
+     *   .groupBy({
+     *     selectFn: item => item.split("@")[1]
+     *   })
+     *   .map(([key, collection]) => [key, collection.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>>>;
     /**
-     * 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:
+     * The <i>countBy</i> method counts the occurrences of values in the collection by {@link CountBySettings | CountBySettings.selectFn}.
+     * By default the equality check occurs on the item.
      * @example
      * const collection = new AsyncIterableCollection(["a", "a", "a", "b", "b", "c"]);
-     * const count = await collection.countBy();
-     * // [["a", 3], ["b", 2], ["c", 1]]
+     * const count = await collection
+     *   .countBy()
+     *   .map(([key, collection]) => [key, collection.toArray()])
+     *   .toArray();
+     * // [
+     * //  ["a", 3],
+     * //  ["b", 2],
+     * //  ["c", 1]
+     * // ]
      * @example
      * const collection = new AsyncIterableCollection(["alice@gmail.com", "bob@yahoo.com", "carlos@gmail.com"]);
-     * const count = await collection.countBy(item => item.split("@")[1])
-     * // [["gmail.com", 2], ["yahoo.com", 1]]
+     * const count = await collection
+     *   .countBy({
+     *     selectFn: item => item.split("@")[1]
+     *   })
+     *   .map(([key, collection]) => [key, collection.toArray()])
+     *   .toArray();
+     * // [
+     * //   ["gmail.com", 2],
+     * //   ["yahoo.com", 1]
+     * // ]
      */
-    countBy<TOutput = TInput>(settings?: AsyncGroupBySettings<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<RecordItem<TOutput, number>>;
+    countBy<TOutput = TInput>(settings?: AsyncCountBySettings<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<RecordItem<TOutput, number>>;
     /**
-     * The unique method removes all duplicate values from the collection:
+     * The <i>unique</i> method removes all duplicate values from the collection by {@link UniqueSettings | UniqueSettings.selectFn}.
+     * By default the equality check occurs on the item.
      * @example
      * const collection = new AsyncIterableCollection([1, 1, 2, 2, 3, 4, 2]);
      * await collection.unique().toArray();
@@ -405,73 +504,141 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      *   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
      *   { name: "Galaxy Gear", brand: "Samsung", type: "watch" },
      * ]);
-     * const unique = collection.unique(item => item.brand);
-     * await unique.toArray();
+     * const unique = await collection.unique({
+     *   selectFn: item => item.brand
+     * }).toArray();
      * // [
-     *   { name: "iPhone 6", brand: "Apple", type: "phone" },
-     *   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
-     * ]
+     * //   { name: "iPhone 6", brand: "Apple", type: "phone" },
+     * //   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
+     * // ]
      */
-    unique<TOutput = TInput>(settings?: AsyncGroupBySettings<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<TInput>;
+    unique<TOutput = TInput>(settings?: AsyncUniqueSettings<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:
+     * The <i>difference</i> method will return the values in the original collection that are not present in <i>iterable</i>.
+     * By default the equality check occurs on the item.
      * @example
-     * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]);
+     * const collection = new AsyncIterableCollection([1, 2, 2, 3, 4, 5]);
      * const difference = collection.difference([2, 4, 6, 8]);
      * await difference.toArray();
      * // [1, 3, 5]
+     * @example
+     * const collection = new AsyncIterableCollection([
+     *   { name: "iPhone 6", brand: "Apple", type: "phone" },
+     *   { name: "iPhone 5", brand: "Apple", type: "phone" },
+     *   { name: "Apple Watch", brand: "Apple", type: "watch" },
+     *   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
+     *   { name: "Galaxy Gear", brand: "Samsung", type: "watch" },
+     * ]);
+     * const difference = collection.difference(
+     *   [
+     *     { name: "Apple Watch", brand: "Apple", type: "watch" },
+     *   ],
+     *   (product) => product.type
+     * );
+     * await difference.toArray();
+     * // [
+     * //   { name: "iPhone 6", brand: "Apple", type: "phone" },
+     * //   { name: "iPhone 5", brand: "Apple", type: "phone" },
+     * //   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
+     * // ]
      */
-    difference<TOutput = TInput>(iterable: AsyncIterableValue<TInput>, map?: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<TInput>;
+    difference<TOutput = TInput>(iterable: AsyncIterableValue<TInput>, selectFn?: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>): IAsyncCollection<TInput>;
     /**
-     * The repeat method will repat the current collection given amount
+     * The <i>repeat</i> method will repeat the original collection <i>amount</i> times.
      * @example
-     * const collection = new ListCollection([1, 2, 3]);
+     * const collection = new AsyncIterableCollection([1, 2, 3]);
      * const newCollection = collection.repeat(3);
-     * newCollection.toArray();
+     * await newCollection.toArray();
      * // [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:
+     * The <i>padStart</i> method pads this collection with <i>fillItems</i> until the resulting collection size reaches <i>maxLength</i>.
+     * The padding is applied from the start of this collection.
      * @example
-     * new ListCollection("abc").padStart(10, "foo").join({ seperator: "" });
+     * const collection = new AsyncIterableCollection("abc").padStart(10, "foo");
+     * await collection.join({ seperator: ""});
      * // "foofoofabc"
-     *
-     * new ListCollection("abc").padStart(6, "123465").join({ seperator: "" });
+     * @example
+     * const collection = new AsyncIterableCollection("abc").padStart(6, "123465");
+     * await collection.join({ seperator: ""});
      * // "123abc"
-     *
-     * new ListCollection("abc").padStart(8, "0").join({ seperator: "" });
+     * @example
+     * const collection = new AsyncIterableCollection("abc").padStart(8, "0");
+     * await collection.join({ seperator: ""});
      * // "00000abc"
-     *
-     * new ListCollection("abc").padStart(1, "_").join({ seperator: "" });
+     * @example
+     * const collection = new AsyncIterableCollection("abc").padStart(1, "_");
+     * await collection.join({ seperator: ""});
      * // "abc"
      */
-    padStart<TExtended = TInput>(maxLength: number, fillItems: AsyncIterableValue<TExtended>): IAsyncCollection<TInput | TExtended>;
+    padStart<TExtended = TInput>(maxLength: number, fillItems: Iterable<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:
+     * The <i>padEnd</i> method pads this collection with <i>fillItems</i> until the resulting collection size reaches <i>maxLength</i>.
+     * The padding is applied from the end of this collection.
      * @example
-     * new ListCollection("abc").padEnd(10, "foo").join({ seperator: "" });
+     * const collection = new AsyncIterableCollection("abc").padEnd(10, "foo");
+     * await collection.join({ seperator: ""});
      * // "abcfoofoof"
-     *
-     * new ListCollection("abc").padEnd(6, "123465").join({ seperator: "" });
+     * @example
+     * const collection = new AsyncIterableCollection("abc").padEnd(6, "123465");
+     * await collection.join({ seperator: ""});
      * // "abc123"
-     *
-     * new ListCollection("abc").padEnd(8, "0").join({ seperator: "" });
+     * @example
+     * const collection = new AsyncIterableCollection("abc").padEnd(8, "0");
+     * await collection.join({ seperator: ""});
      * // "abc00000"
-     *
-     * new ListCollection("abc").padEnd(1, "_").join({ seperator: "" });
+     * @example
+     * const collection = new AsyncIterableCollection("abc").padEnd(1, "_");
+     * await collection.join({ seperator: ""});
      * // "abc"
      */
-    padEnd<TExtended = TInput>(maxLength: number, fillItems: AsyncIterableValue<TExtended>): IAsyncCollection<TInput | TExtended>;
+    padEnd<TExtended = TInput>(maxLength: number, fillItems: Iterable<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}
+     * The <i>slice</i> method creates porition of the original collection selected from {@link SliceSettings | SliceSettings.start} and {@link SliceSettings | SliceSettings.end}
+     * where {@link  SliceSettings | SliceSettings.start} and {@link SliceSettings | SliceSettings.end} (end not included) represent the index of items in the collection.
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]);
+     * await collection.slice({
+     *   start: 3
+     * }).toArray();
+     * // ["d", "e", "f"]
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]);
+     * await collection.slice({
+     *   end: 2,
+     * }).toArray();
+     * // ["a", "b"]
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]);
+     * await collection.slice({
+     *   start: 2
+     *   end: 5,
+     * }).toArray();
+     * // ["c", "d", "e"]
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]);
+     * await collection.slice({
+     *   start: -2
+     * }).toArray();
+     * // ["e", "f"]
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]);
+     * await collection.slice({
+     *   end: -2
+     * }).toArray();
+     * // ["a", "b", "c", "d"]
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]);
+     * await collection.slice({
+     *   start: -4,
+     *   end: -2
+     * }).toArray();
+     * // ["c", "d"]
      */
     slice(settings?: SliceSettings): IAsyncCollection<TInput>;
     /**
-     * The prepend method adds items to the beginning of the collection:
+     * The <i>prepend</i> method adds <i>iterable</i> to the beginning of the collection.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]).prepend([-1, 20]);
      * await collection.toArray();
@@ -479,7 +646,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     prepend<TExtended = TInput>(iterable: AsyncIterableValue<TInput | TExtended>): IAsyncCollection<TInput | TExtended>;
     /**
-     * The append method adds items to the end of the collection:
+     * The <i>append</i> method adds <i>iterable</i> to the end of the collection.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]).append([-1, -2]);
      * await collection.toArray();
@@ -487,23 +654,23 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     append<TExtended = TInput>(iterable: AsyncIterableValue<TInput | TExtended>): IAsyncCollection<TInput | TExtended>;
     /**
-     * The insertBefore method adds items before a specific filtered item:
+     * The <i>insertBefore</i> method adds <i>iterable</i> before the first item that matches <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 2, 3, 4, 5]).insertBefore(item => item === 2, [-1, 20]);
      * 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>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, iterable: AsyncIterableValue<TInput | TExtended>, throwOnIndexOverflow?: boolean): IAsyncCollection<TInput | TExtended>;
     /**
-     * The insertAfter method adds items after a specific filtered item:
+     * The <i>insertAfter</i> method adds <i>iterable</i> after the first item that matches <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 2, 3, 4, 5]).insertAfter(item => item === 2, [-1, 20]);
      * 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>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, iterable: AsyncIterableValue<TInput | TExtended>, throwOnIndexOverflow?: 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:
+     * The <i>crossJoin</i> method cross joins the collection's values among <i>iterables</i>, returning a Cartesian product with all possible permutations.
      * @example
      * const collection = new AsyncIterableCollection([1, 2]);
      * const matrix = collection.crossJoin(["a", "b"]);
@@ -529,24 +696,81 @@ 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<Iterable<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:
+     * The <i>zip</i> method merges together the values of <i>iterable</i> with the values of the collection at their corresponding index.
+     * The returned collection has size of the shortest collection.
      * @example
      * const collection = new AsyncIterableCollection(["Chair", "Desk"]);
      * const zipped = collection.zip([100, 200]);
      * await zipped.toArray();
      * // [["Chari", 100], ["Desk", 200]]
+     * @example
+     * const collection = new AsyncIterableCollection(["Chair", "Desk", "Couch"]);
+     * const zipped = collection.zip([100, 200]);
+     * await zipped.toArray();
+     * // [["Chari", 100], ["Desk", 200]]
+     * @example
+     * const collection = new AsyncIterableCollection(["Chair", "Desk"]);
+     * const zipped = collection.zip([100, 200, 300]);
+     * await zipped.toArray();
+     * // [["Chari", 100], ["Desk", 200]]
      */
     zip<TExtended>(iterable: AsyncIterableValue<TExtended>): IAsyncCollection<RecordItem<TInput, TExtended>>;
-    sort(compare?: Comparator<TInput>): IAsyncCollection<TInput>;
+    /**
+     * The <i>sort</i> method sorts the collection. You can provide a <i>comparator</i> function.
+     * @example
+     * const collection = new AsyncIterableCollection([-1, 2, 4, 3]);
+     * await collection.sort().toArray();
+     * // [-1, 2, 3, 4]
+     * @example
+     * const collection = new AsyncIterableCollection([
+     *   { name: "Anders", age: 30 },
+     *   { name: "Joe", age: 20 },
+     *   { name: "Hasan", age: 25 },
+     *   { name: "Linda", age: 19 }
+     * ]);
+     * await collection.sort(({ age: ageA }, { age: ageB }) => ageA - ageB).toArray();
+     * // [
+     * //   { name: "Linda", age: 19 }
+     * //   { name: "Joe", age: 20 },
+     * //   { name: "Hasan", age: 25 },
+     * //   { name: "Anders", age: 30 },
+     * // ]
+     */
+    sort(comparator?: Comparator<TInput>): IAsyncCollection<TInput>;
+    /**
+     * The <i>reverse</i> method will reverse the order of the collection.
+     * The reversing of the collection will be applied in chunks that are the size of <i>{@link ReverseSettings | ReverseSettings.chunkSize}</i>.
+     * @example
+     * const collection = new AsyncIterableCollection([-1, 2, 4, 3]);
+     * await collection.reverse().toArray();
+     * // [3, 4, 2, -1]
+     */
     reverse(settings?: ReverseSettings): IAsyncCollection<TInput>;
+    /**
+     * The <i>shuffle</i> method randomly shuffles the items in the collection.
+     */
     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:
+     * The <i>first</i> method returns the first item in the collection that passes <i>{@link FindSettings | FindSettings.predicateFn}</i>.
+     * By default it will get the first item. If the collection is empty or no items passes <i>{@link FindSettings | FindSettings.predicateFn}</i> than null i returned.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.first();
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.first({
+     *   predicateFn: item => item > 2
+     * });
+     * // 3
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
-     * await collection.first({ filter: item => item > 2 });
+     * await collection.first({
+     *   predicateFn: item => item > 10
+     * });
+     * // null
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
@@ -554,14 +778,59 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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
+     * The <i>firstOr</i> method returns the first item in the collection that passes <i>{@link FindOrSettings | FindOrSettings.predicateFn}</i>
+     * By default it will get the first item. If the collection is empty or no items passes <i>{@link FindOrSettings | FindOrSettings.predicateFn}</i> than  {@link FindOrSettings | FindOrSettings.defaultValue}.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOr({
+     *   defaultValue: -1
+     * });
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOr({
+     *   predicateFn: item => item > 2,
+     *   defaultValue: -1
+     * });
+     * // 3
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOr({
+     *   predicateFn: item => item > 10,
+     *   defaultValue: -1
+     * });
+     * // -1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOr({
+     *   predicateFn: item => item > 10,
+     *   defaultValue: () => -1
+     * });
+     * // -1
      * @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>;
     /**
-     * The firstOrFail method is the same as first method but will throw an Error if not found
+     * The <i>firstOrFail</i> method returns the first item in the collection that passes <i>{@link FindSettings | FindSettings.predicateFn}</i>.
+     * By default it will get the first item. If the collection is empty or no items passes <i>{@link FindSettings | FindSettings.predicateFn}</i> than error is thrown.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOrFail();
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOrFail({
+     *   predicateFn: item => item > 2
+     * });
+     * // 3
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.firstOrFail({
+     *   predicateFn: item => item > 10
+     * });
+     * // throws an error
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
@@ -569,25 +838,84 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>last</i> method returns the last item in the collection that passes <i>{@link FindSettings | FindSettings.predicateFn}</i>.
+     * By default it will get the last item. If the collection is empty or no items passes <i>{@link FindSettings | FindSettings.predicateFn}</i> than null i returned.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
-     * await collection.last({ filter: item => item > 2 });
-     * // 4
+     * await collection.last();
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.last({
+     *   predicateFn: item => item > 2
+     * });
+     * // 3
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.last({
+     *   predicateFn: item => item > 10
+     * });
+     * // null
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
+     * // 3
      */
     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
+     * The <i>lastOr</i> method returns the last item in the collection that passes <i>{@link FindOrSettings | FindOrSettings.predicateFn}</i>.
+     * By default it will get the last item. If the collection is empty or no items passes <i>{@link FindOrSettings | FindOrSettings.predicateFn}</i> than {@link FindOrSettings | FindOrSettings.defaultValue}.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOr({
+     *   defaultValue: -1
+     * });
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOr({
+     *   predicateFn: item => item > 2,
+     *   defaultValue: -1
+     * });
+     * // 3
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOr({
+     *   predicateFn: item => item > 10,
+     *   defaultValue: -1
+     * });
+     * // -1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOr({
+     *   predicateFn: item => item > 10,
+     *   defaultValue: () => -1
+     * });
+     * // -1
      * @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>;
     /**
-     * The lastOrFail method is the same as last method but will throw an Error if not found
+     * The <i>lastOrFail</i> method returns the last item in the collection that passes <i>{@link FindSettings | FindSettings.predicateFn}</i>.
+     * By default it will get the last item. If the collection is empty or no items passes <i>{@link FindSettings | FindSettings.predicateFn}</i> than error is thrown.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOrFail();
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOrFail({
+     *   predicateFn: item => item > 2
+     * });
+     * // 3
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.lastOrFail({
+     *   predicateFn: item => item > 10
+     * });
+     * // throws an error
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
@@ -595,7 +923,8 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>before</i> method returns the item that comes before the first item that matches <i>predicateFn</i>.
+     * If the <i>predicateFn</i> does not match or matches the first item then null is returned.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
      * await collection.before(item => item === 2);
@@ -608,54 +937,100 @@ 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(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<TInput | null>;
     /**
-     * The beforeOr method is the same as before method but will return a provided default value if not found
+     * The <i>beforeOr</i> method returns the item that comes before the first item that matches <i>predicateFn</i>.
+     * If the collection is empty or the <i>predicateFn</i> does not match or matches the first item then <i>defaultValue</i> is returned.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.beforeOr(-1, item => item === 2);
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.beforeOr(-1, item => item === 1);
+     * // -1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.beforeOr(() => -1, item => item === 1);
+     * // -1
      * @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>, predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<TInput | TExtended>;
     /**
-     * The beforeOrFail method is the same as before method but will throw an Error if not found
+     * The <i>beforeOrFail</i> method returns the item that comes before the first item that matches <i>predicateFn</i>.
+     * If the collection is empty or the <i>predicateFn</i> does not match or matches the first item then an error is thrown.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.beforeOrFail(item => item === 2);
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.beforeOrFail(item => item === 1);
+     * // error is thrown
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    beforeOrFail(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput>;
+    beforeOrFail(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: 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:
+     * The <i>after</i> method returns the item that comes after the first item that matches <i>predicateFn</i>.
+     * If the collection is empty or the <i>predicateFn</i> does not match or matches the last item then null is returned.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
      * await collection.after(item => item === 2);
-     * // 3
+     * // 1
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
-     * await collection.after(item => item === 4);
+     * await collection.after(item => item === 1);
      * // null
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    after(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput | null>;
+    after(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<TInput | null>;
     /**
-     * The afterOr method is the same as after method but will return a provided default value if not found
+     * The <i>afterOr</i> method returns the item that comes after the first item that matches <i>predicateFn</i>.
+     * If the collection is empty or the <i>predicateFn</i> does not match or matches the last item then <i>defaultValue</i> is returned.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.afterOr(-1, item => item === 2);
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.afterOr(-1, item => item === 1);
+     * // -1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.afterOr(() => -1, item => item === 1);
+     * // -1
      * @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>, predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<TInput | TExtended>;
     /**
-     * The afterOrFail method is the same as after method but will throw an Error if not found
+     * The <i>afterOrFail</i> method returns the item that comes after the first item that matches <i>predicateFn</i>.
+     * If the collection is empty or the <i>predicateFn</i> does not match or matches the last item then an error is thrown.
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.afterOrFail(item => item === 2);
+     * // 1
+     * @example
+     * const collection = new AsyncIterableCollection([1, 2, 3, 4]);
+     * await collection.afterOrFail(item => item === 1);
+     * // error is thrown
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {ItemNotFoundError} {@link ItemNotFoundError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    afterOrFail(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<TInput>;
+    afterOrFail(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: 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:
+     * The <i>sole</i> method returns the first item in the collection that passes <i>predicateFn</i>, but only if <i>predicateFn</i> matches exactly one item.
+     * If no items matches or multiple items are found an error will be thrown.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5]);
      * await collection.sole(item => item === 4);
@@ -666,9 +1041,9 @@ 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>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): Promise<TOutput>;
     /**
-     * The nth method creates a new collection consisting of every n-th element:
+     * The <i>nth</i> method creates a new collection consisting of every n-th item.
      * @example
      * const collection = new AsyncIterableCollection(["a", "b", "c", "d", "e", "f"]).nth(4);
      * await collection.toArray();
@@ -676,37 +1051,7 @@ export type IAsyncCollection<TInput> = AsyncIterable<TInput> & {
      */
     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:
+     * The <i>count</i> method returns the total number of items in the collection that passes <i>predicateFn</i>.
      * @example
      * const collection = new AsyncIterableCollection([1, 2, 3, 4, 5, 6]);
      * await collection.count(value => value % 2 === 0);
@@ -715,42 +1060,92 @@ 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(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<number>;
     /**
+     * The <i>size</i> returns the size of the collection.
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    size(throwOnNumberLimit?: boolean): Promise<number>;
+    size(throwOnIndexOverflow?: boolean): Promise<number>;
     /**
+     * The <i>isEmpty</i> returns true if the collection is empty.
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    empty(): Promise<boolean>;
+    isEmpty(): Promise<boolean>;
     /**
+     * The <i>isNotEmpty</i> returns true if the collection is not empty.
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    notEmpty(): Promise<boolean>;
+    isNotEmpty(): 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:
+     * The <i>searchFirst</i> return the index of the first item that matches <i>predicateFn</i>.
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "b", "c"]);
+     * await collection.searchFirst(item => item === "b");
+     * // 1
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    search(filter: AsyncFilter<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<number>;
+    searchFirst(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<number>;
     /**
+     * The <i>searchLast</i> return the index of the last item that matches <i>predicateFn</i>.
+     * @example
+     * const collection = new AsyncIterableCollection(["a", "b", "b", "c"]);
+     * await collection.searchLast(item => item === "b");
+     * // 2
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
-    forEach(callback: AsyncForEach<TInput, IAsyncCollection<TInput>>, throwOnNumberLimit?: boolean): Promise<void>;
+    searchLast(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<number>;
     /**
+     * The <i>forEach</i> method iterates through all items in the collection.
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {IndexOverflowError} {@link IndexOverflowError}
+     */
+    forEach(callback: AsyncForEach<TInput, IAsyncCollection<TInput>>, throwOnIndexOverflow?: boolean): Promise<void>;
+    /**
+     * The <i>toArray</i> method converts the collection to a new array.
      * @throws {CollectionError} {@link CollectionError}
      * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
      * @throws {IndexOverflowError} {@link IndexOverflowError}
      */
     toArray(): Promise<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>;
 };