@daiso-tech/core 0.5.0 → 0.7.0

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

@@ -0,0 +1,1269 @@
+/**
+ * @module Collection
+ */
+import type { Comparator, Predicate, ForEach, Map, Modifier, Tap, Transform, ChangendItem, Reduce, CrossJoinResult } from "../../collection/contracts/_shared";
+import type { Lazyable, RecordItem, EnsureType } from "../../_shared/types";
+export type Collapse<TValue> = TValue extends Array<infer TItem> | Iterable<infer TItem> | ICollection<infer TItem> ? TItem : TValue;
+/**
+ * <i>ICollection</i> is immutable.
+ * @throws {CollectionError}
+ * @throws {UnexpectedCollectionError}
+ * @throws {ItemNotFoundCollectionError}
+ * @throws {MultipleItemsFoundCollectionError}
+ * @throws {TypeCollectionError}
+ * @throws {EmptyCollectionError}
+ * @group Contracts
+ */
+export type ICollection<TInput> = Iterable<TInput> & {
+    /**
+     * The <i>toIterator</i> method converts the collection to a new iterator.
+     */
+    toIterator(): Iterator<TInput, void>;
+    /**
+     * The <i>entries</i> returns an ICollection of key, value pairs for every entry in the collection.
+     */
+    entries(): ICollection<RecordItem<number, TInput>>;
+    /**
+     * The <i>keys</i> method returns an ICollection of keys in the collection.
+     */
+    keys(): ICollection<number>;
+    /**
+     * The <i>values</i> method returns a copy of the collection.
+     */
+    values(): ICollection<TInput>;
+    /**
+     * The <i>filter</i> method filters the collection using <i>predicateFn</i>, keeping only those items that pass <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6]);
+     * const filtered = collection.filter(item => 2 < item && item < 5);
+     * filtered.toArray();
+     * // [3, 4]
+     */
+    filter<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>): ICollection<TOutput>;
+    /**
+     * The <i>reject</i> method filters the collection using <i>predicateFn</i>, keeping only those items that not pass <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6]);
+     * const filtered = collection.reject(item => 2 < item && item < 5);
+     * filtered.toArray();
+     * // [1, 2, 5, 6]
+     */
+    reject<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>): ICollection<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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5]);
+     * const mapped = collection.map(item => item * 2);
+     * mapped.toArray();
+     * // [2, 4, 6, 8, 10]
+     */
+    map<TOutput>(mapFn: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TOutput>;
+    /**
+     * The <i>reduce</i> method executes <i> 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * collection.reduce((sum, item) => sum + item);
+     * // 6
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c"]);
+     * collection.entries().reduce(
+     *   (record, [key, value]) => ({
+     *     ...record,
+     *     [key]: value
+     *   }),
+     *   {} as Record<number, string>
+     * );
+     * // { 0: "a", 1: "b", 2: "c" }
+     */
+    reduce(reduceFn: Reduce<TInput, ICollection<TInput>, TInput>): TInput;
+    reduce(reduceFn: Reduce<TInput, ICollection<TInput>, TInput>, initialValue: TInput): TInput;
+    reduce<TOutput>(reduceFn: Reduce<TInput, ICollection<TInput>, TOutput>, initialValue: TOutput): TOutput;
+    /**
+     * The <i>join</i> method joins the collection's items with <i> separator </i>. An error will be thrown when if a none string item is encounterd.
+     * @throws {TypeCollectionError}
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.map(item => item.toString()).join();
+     * // "1,2,3,4"
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.map(item => item.toString()).join("_");
+     * // "1_2_3_4"
+     */
+    join(separator?: string): EnsureType<TInput, string>;
+    /**
+     * The <i>collapse</i> method collapses a collection of iterables into a single, flat collection.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([[1, 2], [3, 4]]);
+     * const collapsed = collection.collapse();
+     * collapsed.toArray();
+     * // [1, 2, 3, 4]
+     */
+    collapse(): ICollection<Collapse<TInput>>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([["a", "b"], ["c", "d"]]).flatMap(item => [item.length, ...item]);
+     * collection.toArray();
+     * // [2, "a", "b", 2, "c", "d"]
+     */
+    flatMap<TOutput>(mapFn: Map<TInput, ICollection<TInput>, Iterable<TOutput>>): ICollection<TOutput>;
+    /**
+     * The <i>change</i> method changes only the items that passes <i>predicateFn</i> using <i>mapFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5]);
+     * const newCollection = collection.change(item => item % 2 === 0, item => item * 2);
+     * newCollection.toArray();
+     * // [1, 4, 3, 8, 5]
+     */
+    change<TFilterOutput extends TInput, TMapOutput>(predicateFn: Predicate<TInput, ICollection<TInput>, TFilterOutput>, mapFn: Map<TFilterOutput, ICollection<TInput>, TMapOutput>): ICollection<ChangendItem<TInput, TFilterOutput, TMapOutput>>;
+    /**
+     * The <i>page</i> method returns a new collection containing the items that would be present on <i> page </i> with custom <i> pageSize </i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6, 7, 8, 9]);
+     * const page = collection.page(2, 3);
+     * page.toArray();
+     * // [4, 5, 6]
+     */
+    page(page: number, pageSize: number): ICollection<TInput>;
+    /**
+     * 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.
+     * If the collection is empty an error will also be thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * collection.sum();
+     * // 6
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {TypeCollectionError} {@link TypeCollectionError}
+     * @throws {EmptyCollectionError} {@link EmptyCollectionError}
+     */
+    sum(): EnsureType<TInput, number>;
+    /**
+     * 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.
+     * If the collection is empty an error will also be thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * collection.average();
+     * // 2
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {TypeCollectionError} {@link TypeCollectionError}
+     * @throws {EmptyCollectionError} {@link EmptyCollectionError}
+     */
+    average(): EnsureType<TInput, number>;
+    /**
+     * 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.
+     * If the collection is empty an error will also be thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * collection.median();
+     * // 2
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {TypeCollectionError} {@link TypeCollectionError}
+     * @throws {EmptyCollectionError} {@link EmptyCollectionError}
+     */
+    median(): EnsureType<TInput, number>;
+    /**
+     * 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.
+     * If the collection is empty an error will also be thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * collection.min();
+     * // 1
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {TypeCollectionError} {@link TypeCollectionError}
+     * @throws {EmptyCollectionError} {@link EmptyCollectionError}
+     */
+    min(): EnsureType<TInput, number>;
+    /**
+     * 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.
+     * If the collection is empty an error will also be thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * collection.max();
+     * // 3
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {TypeCollectionError} {@link TypeCollectionError}
+     * @throws {EmptyCollectionError} {@link EmptyCollectionError}
+     */
+    max(): EnsureType<TInput, number>;
+    /**
+     * The <i>percentage</i> method may be used to quickly determine the percentage of items in the collection that pass <i>predicateFn</i>.
+     * If the collection is empty an error will also be thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 1, 2, 2, 2, 3]);
+     * collection.percentage(value => value === 1);
+     * // 33.333
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {EmptyCollectionError} {@link EmptyCollectionError}
+     */
+    percentage(predicateFn: Predicate<TInput, ICollection<TInput>>): number;
+    /**
+     * The <i>some</i> method determines whether at least one item in the collection matches <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([0, 1, 2, 3, 4, 5]);
+     * collection.some(item => item === 1);
+     * // true
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    some<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>): boolean;
+    /**
+     * The <i>every</i> method determines whether all items in the collection matches <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([0, 1, 2, 3, 4, 5]);
+     * collection.every(item => item < 6);
+     * // true
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    every<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>): boolean;
+    /**
+     * The <i>take</i> method takes the first <i>limit</i> items.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([0, 1, 2, 3, 4, 5]);
+     * const chunk = collection.take(3);
+     * chunk.toArray();
+     * // [0, 1, 2]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([0, 1, 2, 3, 4, 5]);
+     * const chunk = collection.take(-2);
+     * chunk.toArray();
+     * // [0, 1, 2, 3]
+     */
+    take(limit: number): ICollection<TInput>;
+    /**
+     * The <i>takeUntil</i> method takes items until <i>predicateFn</i> returns true.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * const chunk = collection.takeUntil(item => item >= 3);
+     * chunk.toArray();
+     * // [1, 2]
+     */
+    takeUntil(predicateFn: Predicate<TInput, ICollection<TInput>>): ICollection<TInput>;
+    /**
+     * The <i>takeWhile</i> method takes items until <i>predicateFn</i> returns false.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * const chunk = collection.takeWhile(item => item < 4);
+     * chunk.toArray();
+     * // [1, 2, 3]
+     */
+    takeWhile(predicateFn: Predicate<TInput, ICollection<TInput>>): ICollection<TInput>;
+    /**
+     * The <i>skip</i> method skips the first <i>offset</i> items.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]).skip(4);
+     * collection.toArray();
+     * // [5, 6, 7, 8, 9, 10]
+     */
+    skip(offset: number): ICollection<TInput>;
+    /**
+     * The <i>skipUntil</i> method skips items until <i>predicateFn</i> returns true.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]).skipUntil(item => item >= 3);
+     * collection.toArray();
+     * // [3, 4]
+     */
+    skipUntil(predicateFn: Predicate<TInput, ICollection<TInput>>): ICollection<TInput>;
+    /**
+     * The <i>skipWhile</i> method skips items until <i>predicateFn</i> returns false.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]).skipWhile(item => item <= 3);
+     * collection.toArray();
+     * // [4]
+     */
+    skipWhile(predicateFn: Predicate<TInput, ICollection<TInput>>): ICollection<TInput>;
+    /**
+     * The <i>when</i> method will execute <i>callback</i> when <i>condition</i> evaluates to true.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4])
+     *  .when(true, collection => collection.append([-3]))
+     *  .when(false, collection => collection.append([20]));
+     * collection.toArray();
+     * // [1, 2, 3, 4, -3]
+     */
+    when<TExtended = TInput>(condition: boolean, callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>whenEmpty</i> method will execute <i>callback</i> when the collection is empty.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([])
+     *  .whenEmpty(collection => collection.append([-3]))
+     * collection.toArray();
+     * // [-3]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1])
+     *  .whenEmpty(collection => collection.append([-3]))
+     * collection.toArray();
+     * // [1]
+     */
+    whenEmpty<TExtended = TInput>(callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>whenNot</i> method will execute <i>callback</i> when <i>condition</i> evaluates to false.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4])
+     *  .whenNot(true, collection => collection.append([-3]))
+     *  .whenNot(false, collection => collection.append([20]));
+     * collection.toArray();
+     * // [1, 2, 3, 4, 20]
+     */
+    whenNot<TExtended = TInput>(condition: boolean, callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>whenNotEmpty</i> method will execute <i>callback</i> when the collection is not empty.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([])
+     *  .whenNotEmpty(collection => collection.append([-3]))
+     * collection.toArray();
+     * // []
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1])
+     *  .whenNotEmpty(collection => collection.append([-3]))
+     * collection.toArray();
+     * // [1, -3]
+     */
+    whenNotEmpty<TExtended = TInput>(callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, "2", "a", 1, 3, {}]);
+     * function toNbrs<TInput>(
+     *       collection: ICollection<TInput>,
+     * ): ICollection<number> {
+     *   return collection
+     *     .map((item) => Number(item))
+     *     .reject((nbr) => Number.isNaN(nbr));
+     * }
+     * function nbrToStr(collection: ICollection<number>): number[] {
+     *   return collection.repeat(2).toArray();
+     * }
+     * const piped = collection.pipe(toNbrs).pipe(nbrToStr);
+     * console.log(piped);
+     * // [ 1, 2, 1, 3 ]
+     */
+    pipe<TOutput = TInput>(callback: Transform<ICollection<TInput>, TOutput>): TOutput;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6])
+     *   .tap(collection => {
+     *     collection
+     *       .filter(value => value % 2 === 0)
+     *       .forEach(value => console.log(value))
+     *   })
+     *   .toArray();
+     * // [1, 2, 3, 4, 5, 6]
+     */
+    tap(callback: Tap<ICollection<TInput>>): ICollection<TInput>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6, 7]);
+     * const chunks = collection.chunk(4);
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * // [[1, 2, 3, 4], [5, 6, 7]]
+     */
+    chunk(chunkSize: number): ICollection<ICollection<TInput>>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection("AABBCCCD");
+     * const chunks = collection.chunkWhile((value, index, chunk) => {
+     *  return value === chunk.last();
+     * });
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * //  [["A", "A"], ["B", "B"], ["C", "C", "C"], ["D"]]
+     */
+    chunkWhile(predicateFn: Predicate<TInput, ICollection<TInput>>): ICollection<ICollection<TInput>>;
+    /**
+     * The <i>split</i> method breaks a collection evenly into <i>chunkAmount</i> of chunks.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5]);
+     * const chunks = collection.split(3);
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * // [[1, 2], [3, 4], [5]]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6]);
+     * const chunks = collection.split(3);
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * // [[1, 2], [3, 4], [5, 6]]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6, 7]);
+     * const chunks = collection.split(3);
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * // [[1, 2, 7], [3, 4], [5, 6]]
+     */
+    split(chunkAmount: number): ICollection<ICollection<TInput>>;
+    /**
+     * The <i>partition</i> method is used to separate items that pass <i>predicateFn</i> from those that do not.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6]);
+     * const chunks = collection.partition(item => item < 3);
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * // [[1, 2], [3, 4, 5, 6]]
+     */
+    partition(predicateFn: Predicate<TInput, ICollection<TInput>>): ICollection<ICollection<TInput>>;
+    /**
+     * The <i>sliding</i> method returns a new collection of chunks representing a "sliding window" view of the items in the collection.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5])
+     * const chunks = collection.sliding(2);
+     * chunks.map(chunk => chunk.toArray()).toArray();
+     * // [[1, 2], [2, 3], [3, 4], [4, 5]]
+     */
+    sliding(chunkSize: number, step?: number): ICollection<ICollection<TInput>>;
+    /**
+     * The <i>groupBy</i> method groups the collection's items by <i> selectFn </i>.
+     * By default the equality check occurs on the item.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "a", "a", "b", "b", "c"]);
+     * const group = collection
+     *   .groupBy()
+     *   .map(([key, collection]) => [key, collection.toArray()])
+     *   .toArray();
+     * // [
+     * //  [
+     * //    "a",
+     * //    ["a", "a", "a"]
+     * //  ],
+     * //  [
+     * //    "b",
+     * //    ["b", "b"]
+     * //  ],
+     * //  [
+     * //    "c",
+     * //    ["c"]
+     * //  ]
+     * // ]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["alice@gmail.com", "bob@yahoo.com", "carlos@gmail.com"]);
+     * const group = collection
+     *   .groupBy(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>(selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, ICollection<TInput>>>;
+    /**
+     * The <i>countBy</i> method counts the occurrences of values in the collection by <i> selectFn </i>.
+     * By default the equality check occurs on the item.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "a", "a", "b", "b", "c"]);
+     * const count = collection
+     *   .countBy()
+     *   .map(([key, collection]) => [key, collection.toArray()])
+     *   .toArray();
+     * // [
+     * //  ["a", 3],
+     * //  ["b", 2],
+     * //  ["c", 1]
+     * // ]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["alice@gmail.com", "bob@yahoo.com", "carlos@gmail.com"]);
+     * const count = collection
+     *   .countBy(item => item.split("@")[1])
+     *   .toArray();
+     * // [
+     * //   ["gmail.com", 2],
+     * //   ["yahoo.com", 1]
+     * // ]
+     */
+    countBy<TOutput = TInput>(selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, number>>;
+    /**
+     * The <i>unique</i> method removes all duplicate values from the collection by <i> selectFn </i>.
+     * By default the equality check occurs on the item.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 1, 2, 2, 3, 4, 2]);
+     * collection.unique().toArray();
+     * // [1, 2, 3, 4]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([
+     *   { 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 unique = collection.unique({
+     *   selectFn: item => item.brand
+     * }).toArray();
+     * // [
+     * //   { name: "iPhone 6", brand: "Apple", type: "phone" },
+     * //   { name: "Galaxy S6", brand: "Samsung", type: "phone" },
+     * // ]
+     */
+    unique<TOutput = TInput>(selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 2, 3, 4, 5]);
+     * const difference = collection.difference([2, 4, 6, 8]);
+     * difference.toArray();
+     * // [1, 3, 5]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([
+     *   { 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
+     * );
+     * 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: Iterable<TInput>, selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
+    /**
+     * The <i>repeat</i> method will repeat the original collection <i>amount</i> times.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3]);
+     * const newCollection = collection.repeat(3);
+     * newCollection.toArray();
+     * // [1, 2, 3,  1, 2, 3,  1, 2, 3]
+     */
+    repeat(amount: number): ICollection<TInput>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * new ListCollection("abc").padStart(10, "foo").join("");
+     * // "foofoofabc"
+     *
+     * new ListCollection("abc").padStart(6, "123465").join("");
+     * // "123abc"
+     *
+     * new ListCollection("abc").padStart(8, "0").join("");
+     * // "00000abc"
+     *
+     * new ListCollection("abc").padStart(1, "_").join("");
+     * // "abc"
+     */
+    padStart<TExtended = TInput>(maxLength: number, fillItems: Iterable<TExtended>): ICollection<TInput | TExtended>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * new ListCollection("abc").padEnd(10, "foo").join("");
+     * // "abcfoofoof"
+     *
+     * new ListCollection("abc").padEnd(6, "123465").join("");
+     * // "abc123"
+     *
+     * new ListCollection("abc").padEnd(8, "0").join("");
+     * // "abc00000"
+     *
+     * new ListCollection("abc").padEnd(1, "_").join("");
+     * // "abc"
+     */
+    padEnd<TExtended = TInput>(maxLength: number, fillItems: Iterable<TExtended>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>slice</i> method creates porition of the original collection selected from <i>start</i> and <i>end</i>
+     * where <i>start</i> and <i>end</i> (end not included) represent the index of items in the collection.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]);
+     * collection.slice(3).toArray();
+     * // ["d", "e", "f"]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]);
+     * collection.slice(undefined, 2).toArray();
+     * // ["a", "b"]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]);
+     * collection.slice(2, 5).toArray();
+     * // ["c", "d", "e"]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]);
+     * collection.slice(-2).toArray();
+     * // ["e", "f"]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]);
+     * collection.slice(undefined, -2).toArray();
+     * // ["a", "b", "c", "d"]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]);
+     * collection.slice(-4, -2).toArray();
+     * // ["c", "d"]
+     */
+    slice(start?: number, end?: number): ICollection<TInput>;
+    /**
+     * The <i>prepend</i> method adds <i>iterable</i> to the beginning of the collection.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5]).prepend([-1, 20]);
+     * collection.toArray();
+     * // [-1, 20, 1, 2, 3, 4, 5]
+     */
+    prepend<TExtended = TInput>(iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>append</i> method adds <i>iterable</i> to the end of the collection.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5]).append([-1, -2]);
+     * collection.toArray();
+     * // [1, 2, 3, 4, 5, -1, -2,]
+     */
+    append<TExtended = TInput>(iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>insertBefore</i> method adds <i>iterable</i> before the first item that matches <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 2, 3, 4, 5]).insertBefore(item => item === 2, [-1, 20]);
+     * collection.toArray();
+     * // [1, -1, 20, 2, 2, 3, 4, 5]
+     */
+    insertBefore<TExtended = TInput>(predicateFn: Predicate<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>insertAfter</i> method adds <i>iterable</i> after the first item that matches <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 2, 3, 4, 5]).insertAfter(item => item === 2, [-1, 20]);
+     * collection.toArray();
+     * // [1, 2, -1, 20, 2, 3, 4, 5]
+     */
+    insertAfter<TExtended = TInput>(predicateFn: Predicate<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
+    /**
+     * The <i>crossJoin</i> method cross joins the collection's values among <i>iterables</i>, returning a Cartesian product with all possible permutations.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2]);
+     * const matrix = collection.cross(["a", "b"]);
+     * matrix.toArray();
+     * // [
+     * //  [1, "a"],
+     * //  [1, "b"],
+     * //  [2, "a"],
+     * //  [2, "b"],
+     * // ]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2]);
+     * const matrix = collection.cross(["a", "b"]).cross(["I", "II"]);
+     * matrix.toArray();
+     * // [
+     * //  [1, "a", "I"],
+     * //  [1, "a", "II"],
+     * //  [1, "b", "I"],
+     * //  [1, "b", "II"],
+     * //  [2, "a", "I"],
+     * //  [2, "a", "II"],
+     * //  [2, "b", "I"],
+     * //  [2, "b", "II"],
+     * // ]
+     */
+    crossJoin<TExtended>(iterable: Iterable<TExtended>): ICollection<CrossJoinResult<TInput, TExtended>>;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["Chair", "Desk"]);
+     * const zipped = collection.zip([100, 200]);
+     * zipped.toArray();
+     * // [["Chair", 100], ["Desk", 200]]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["Chair", "Desk", "Couch"]);
+     * const zipped = collection.zip([100, 200]);
+     * zipped.toArray();
+     * // [["Chair", 100], ["Desk", 200]]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["Chair", "Desk"]);
+     * const zipped = collection.zip([100, 200, 300]);
+     * zipped.toArray();
+     * // [["Chair", 100], ["Desk", 200]]
+     */
+    zip<TExtended>(iterable: Iterable<TExtended>): ICollection<RecordItem<TInput, TExtended>>;
+    /**
+     * The <i>sort</i> method sorts the collection. You can provide a <i>comparator</i> function.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([-1, 2, 4, 3]);
+     * collection.sort().toArray();
+     * // [-1, 2, 3, 4]
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([
+     *   { name: "Anders", age: 30 },
+     *   { name: "Joe", age: 20 },
+     *   { name: "Hasan", age: 25 },
+     *   { name: "Linda", age: 19 }
+     * ]);
+     * 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>): ICollection<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> chunkSize </i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([-1, 2, 4, 3]);
+     * collection.reverse().toArray();
+     * // [3, 4, 2, -1]
+     */
+    reverse(chunkSize?: number): ICollection<TInput>;
+    /**
+     * The <i>shuffle</i> method randomly shuffles the items in the collection. You can provide a custom Math.random function by passing in <i>mathRandom</i>.
+     */
+    shuffle(mathRandom?: () => number): ICollection<TInput>;
+    /**
+     * The <i>first</i> method returns the first item in the collection that passes <i> predicateFn </i>.
+     * By default it will get the first item. If the collection is empty or no items passes <i> predicateFn </i> than null i returned.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.first();
+     * // 1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.first(item => item > 2);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.first(item => item > 10);
+     * // null
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * // 3
+     */
+    first<TOutput extends TInput>(predicateFn?: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput | null;
+    /**
+     * The <i>firstOr</i> method returns the first item in the collection that passes <i> predicateFn </i>
+     * By default it will get the first item. If the collection is empty or no items passes <i> predicateFn </i> than <i> defaultValue </i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOr(-1);
+     * // 1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOr(-1, item => item > 2);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOr(-1, item => item > 10);
+     * // -1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOr(() => -1, item => item > 10);
+     * // -1
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    firstOr<TOutput extends TInput, TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn?: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput | TExtended;
+    /**
+     * The <i>firstOrFail</i> method returns the first item in the collection that passes <i> predicateFn </i>.
+     * By default it will get the first item. If the collection is empty or no items passes <i> predicateFn </i> than error is thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOrFail();
+     * // 1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOrFail(item => item > 2);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.firstOrFail(item => item > 10);
+     * // throws an error
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
+     */
+    firstOrFail<TOutput extends TInput>(predicateFn?: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput;
+    /**
+     * The <i>last</i> method returns the last item in the collection that passes <i> predicateFn </i>.
+     * By default it will get the last item. If the collection is empty or no items passes <i> predicateFn </i> than null i returned.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.last();
+     * // 4
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.last(item => item < 4);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.last(item => item > 10);
+     * // null
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * // 3
+     */
+    last<TOutput extends TInput>(predicateFn?: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput | null;
+    /**
+     * The <i>lastOr</i> method returns the last item in the collection that passes <i> predicateFn </i>.
+     * By default it will get the last item. If the collection is empty or no items passes <i> predicateFn </i> than <i> defaultValue </i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOr(-1);
+     * // 4
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOr(-1, item => item < 4);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOr(-1, item => item > 10);
+     * // -1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOr(() => -1, item => item > 10);
+     * // -1
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    lastOr<TOutput extends TInput, TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn?: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput | TExtended;
+    /**
+     * The <i>lastOrFail</i> method returns the last item in the collection that passes <i> predicateFn </i>.
+     * By default it will get the last item. If the collection is empty or no items passes <i> predicateFn </i> than error is thrown.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOrFail();
+     * // 4
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOrFail(item => item < 4);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.lastOrFail(item => item > 10);
+     * // throws an error
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
+     */
+    lastOrFail<TOutput extends TInput>(predicateFn?: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.before(item => item === 2);
+     * // 1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.before(item => item === 1);
+     * // null
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    before(predicateFn: Predicate<TInput, ICollection<TInput>>): TInput | null;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.beforeOr(-1, item => item === 2);
+     * // 1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.beforeOr(-1, item => item === 1);
+     * // -1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.beforeOr(() => -1, item => item === 1);
+     * // -1
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    beforeOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: Predicate<TInput, ICollection<TInput>>): TInput | TExtended;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.beforeOrFail(item => item === 2);
+     * // 1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.beforeOrFail(item => item === 1);
+     * // error is thrown
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
+     */
+    beforeOrFail(predicateFn: Predicate<TInput, ICollection<TInput>>): TInput;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.after(item => item === 2);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.after(item => item === 4);
+     * // null
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    after(predicateFn: Predicate<TInput, ICollection<TInput>>): TInput | null;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.afterOr(-1, item => item === 2);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.afterOr(-1, item => item === 4);
+     * // -1
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.afterOr(() => -1, item => item === 4);
+     * // -1
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    afterOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: Predicate<TInput, ICollection<TInput>>): TInput | TExtended;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.afterOrFail(item => item === 2);
+     * // 3
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4]);
+     * collection.afterOrFail(item => item === 4);
+     * // error is thrown
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
+     */
+    afterOrFail(predicateFn: Predicate<TInput, ICollection<TInput>>): TInput;
+    /**
+     * 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
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5]);
+     * collection.sole(item => item === 4);
+     * // 4
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 4, 5]);
+     * collection.sole(item => item === 4);
+     * // error is thrown
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 5]);
+     * collection.sole(item => item === 4);
+     * // error is thrown
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
+     * @throws {MultipleItemsFoundCollectionError} {@link MultipleItemsFoundCollectionError}
+     */
+    sole<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>): TOutput;
+    /**
+     * The <i>nth</i> method creates a new collection consisting of every n-th item.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "c", "d", "e", "f"]).nth(4);
+     * collection.toArray();
+     * // ["a", "e"]
+     */
+    nth(step: number): ICollection<TInput>;
+    /**
+     * The <i>count</i> method returns the total number of items in the collection that passes <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection([1, 2, 3, 4, 5, 6]);
+     * collection.count(value => value % 2 === 0);
+     * // 3
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    count(predicateFn: Predicate<TInput, ICollection<TInput>>): number;
+    /**
+     * The <i>size</i> returns the size of the collection.
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    size(): number;
+    /**
+     * The <i>isEmpty</i> returns true if the collection is empty.
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    isEmpty(): boolean;
+    /**
+     * The <i>isNotEmpty</i> returns true if the collection is not empty.
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    isNotEmpty(): boolean;
+    /**
+     * The <i>searchFirst</i> return the index of the first item that matches <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "b", "c"]);
+     * collection.searchFirst(item => item === "b");
+     * // 1
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    searchFirst(predicateFn: Predicate<TInput, ICollection<TInput>>): number;
+    /**
+     * The <i>searchLast</i> return the index of the last item that matches <i>predicateFn</i>.
+     * @example
+     * import { ListCollection } from "@daiso-tech/core";;
+     *
+     * const collection = new ListCollection(["a", "b", "b", "c"]);
+     * collection.searchLast(item => item === "b");
+     * // 2
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    searchLast(predicateFn: Predicate<TInput, ICollection<TInput>>): number;
+    /**
+     * The <i>forEach</i> method iterates through all items in the collection.
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    forEach(callback: ForEach<TInput, ICollection<TInput>>): void;
+    /**
+     * The <i>toArray</i> method converts the collection to a new array.
+     * @throws {CollectionError} {@link CollectionError}
+     * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
+     */
+    toArray(): TInput[];
+};