@daiso-tech/core 0.1.2 → 0.1.3

package/dist/types/collection/iterable-collection/iterable-collection.d.ts

@@ -1,42 +1,50 @@
-import { type Collapse, type Comparator, type Filter, type FindOrSettings, type FindSettings, type ForEach, type GroupBySettings, type ICollection, type JoinSettings, type Lazyable, type Map, type Modifier, type PageSettings, type RecordItem, type ReduceSettings, type ReverseSettings, type SliceSettings, type SlidingSettings, type Tap, type Transform, type UpdatedItem } from "../../contracts/collection/_module";
-import { type EnsureType } from "../../types";
 /**
- * Most methods in IterableCollection are lazy and will only execute when calling methods return values or iterating through an IterableCollection by using for of loop.
- * @group Collections
+ * @module Collections
+ */
+import { type Collapse, type Comparator, type Predicate, type FindOrSettings, type FindSettings, type ForEach, type GroupBySettings, type CountBySettings, type UniqueSettings, type ICollection, type JoinSettings, type Lazyable, type Map, type Modifier, type PageSettings, type RecordItem, type ReduceSettings, type ReverseSettings, type SliceSettings, type SlidingSettings, type Tap, type Transform, type UpdatedItem } from "../../contracts/collection/_module";
+import { type EnsureType } from "../../_shared/types";
+/**
+ * All methods that return <i>{@link ICollection}</i> are executed lazly which means they will be executed when the <i>IterableCollection</i> is iterated with <i>forEach</i> method or "for of" loop.
+ * The rest of the methods are executed eagerly.
+ * @group Adapters
  */
 export declare class IterableCollection<TInput> implements ICollection<TInput> {
     private iterable;
     private static THROW_ON_NUMBER_LIMIT;
     private static DEFAULT_CHUNK_SIZE;
     private static makeCollection;
+    /**
+     * The <i>constructor</i> takes an <i>{@link Iterable}</i>.
+     */
     constructor(iterable: Iterable<TInput>);
     [Symbol.iterator](): Iterator<TInput>;
-    iterator(): Iterator<TInput, void>;
-    entries(throwOnNumberLimit?: boolean): ICollection<RecordItem<number, TInput>>;
-    keys(throwOnNumberLimit?: boolean): ICollection<number>;
+    toIterator(): Iterator<TInput, void>;
+    entries(throwOnIndexOverflow?: boolean): ICollection<RecordItem<number, TInput>>;
+    keys(throwOnIndexOverflow?: boolean): ICollection<number>;
     values(): ICollection<TInput>;
-    filter<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): ICollection<TOutput>;
-    map<TOutput>(map: Map<TInput, ICollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): ICollection<TOutput>;
+    filter<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): ICollection<TOutput>;
+    reject<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): ICollection<Exclude<TInput, TOutput>>;
+    map<TOutput>(mapFn: Map<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): ICollection<TOutput>;
     reduce<TOutput = TInput>(settings: ReduceSettings<TInput, ICollection<TInput>, TOutput>): TOutput;
-    join(settings?: JoinSettings): string;
+    join(settings?: JoinSettings): EnsureType<TInput, string>;
     collapse(): ICollection<Collapse<TInput>>;
-    flatMap<TOutput>(map: Map<TInput, ICollection<TInput>, Iterable<TOutput>>, throwOnNumberLimit?: boolean): ICollection<TOutput>;
-    update<TFilterOutput extends TInput, TMapOutput>(filter: Filter<TInput, ICollection<TInput>, TFilterOutput>, map: Map<TFilterOutput, ICollection<TInput>, TMapOutput>, throwOnNumberLimit?: boolean): ICollection<UpdatedItem<TInput, TFilterOutput, TMapOutput>>;
+    flatMap<TOutput>(mapFn: Map<TInput, ICollection<TInput>, Iterable<TOutput>>, throwOnIndexOverflow?: boolean): ICollection<TOutput>;
+    update<TFilterOutput extends TInput, TMapOutput>(predicateFn: Predicate<TInput, ICollection<TInput>, TFilterOutput>, mapFn: Map<TFilterOutput, ICollection<TInput>, TMapOutput>, throwOnIndexOverflow?: boolean): ICollection<UpdatedItem<TInput, TFilterOutput, TMapOutput>>;
     page(settings: PageSettings): ICollection<TInput>;
     sum(): EnsureType<TInput, number>;
     average(): EnsureType<TInput, number>;
-    median(throwOnNumberLimit?: boolean): EnsureType<TInput, number>;
+    median(throwOnIndexOverflow?: boolean): EnsureType<TInput, number>;
     min(): EnsureType<TInput, number>;
     max(): EnsureType<TInput, number>;
-    percentage(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): number;
-    some<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): boolean;
-    every<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): boolean;
-    take(limit: number, throwOnNumberLimit?: boolean): ICollection<TInput>;
-    takeUntil(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): ICollection<TInput>;
-    takeWhile(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): ICollection<TInput>;
-    skip(offset: number, throwOnNumberLimit?: boolean): ICollection<TInput>;
-    skipUntil(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): ICollection<TInput>;
-    skipWhile<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): ICollection<TInput>;
+    percentage(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): number;
+    some<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): boolean;
+    every<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): boolean;
+    take(limit: number, throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    takeUntil(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    takeWhile(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    skip(offset: number, throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    skipUntil(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    skipWhile<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): ICollection<TInput>;
     when<TExtended = TInput>(condition: boolean, callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
     whenEmpty<TExtended = TInput>(callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
     whenNot<TExtended = TInput>(condition: boolean, callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
@@ -44,25 +52,25 @@ export declare class IterableCollection<TInput> implements ICollection<TInput> {
     pipe<TOutput = TInput>(callback: Transform<ICollection<TInput>, TOutput>): TOutput;
     tap(callback: Tap<ICollection<TInput>>): ICollection<TInput>;
     chunk(chunkSize: number): ICollection<ICollection<TInput>>;
-    chunkWhile(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): ICollection<ICollection<TInput>>;
-    split(chunkAmount: number, throwOnNumberLimit?: boolean): ICollection<ICollection<TInput>>;
-    partition(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): ICollection<ICollection<TInput>>;
+    chunkWhile(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): ICollection<ICollection<TInput>>;
+    split(chunkAmount: number, throwOnIndexOverflow?: boolean): ICollection<ICollection<TInput>>;
+    partition(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): ICollection<ICollection<TInput>>;
     sliding(settings: SlidingSettings): ICollection<ICollection<TInput>>;
     groupBy<TOutput = TInput>(settings?: GroupBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, ICollection<TInput>>>;
-    countBy<TOutput = TInput>(settings?: GroupBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, number>>;
-    unique<TOutput>(settings?: GroupBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
-    difference<TOutput = TInput>(iterable: Iterable<TInput>, map?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
+    countBy<TOutput = TInput>(settings?: CountBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, number>>;
+    unique<TOutput>(settings?: UniqueSettings<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
+    difference<TOutput = TInput>(iterable: Iterable<TInput>, mapFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
     repeat(amount: number): ICollection<TInput>;
     padStart<TExtended = TInput>(maxLength: number, fillItems: Iterable<TExtended>): ICollection<TInput | TExtended>;
     padEnd<TExtended = TInput>(maxLength: number, fillItems: Iterable<TExtended>): ICollection<TInput | TExtended>;
     slice(settings?: SliceSettings): ICollection<TInput>;
     prepend<TExtended = TInput>(iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
     append<TExtended = TInput>(iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
-    insertBefore<TExtended = TInput>(filter: Filter<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, throwOnNumberLimit?: boolean): ICollection<TInput | TExtended>;
-    insertAfter<TExtended = TInput>(filter: Filter<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, throwOnNumberLimit?: boolean): ICollection<TInput | TExtended>;
+    insertBefore<TExtended = TInput>(predicateFn: Predicate<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, throwOnIndexOverflow?: boolean): ICollection<TInput | TExtended>;
+    insertAfter<TExtended = TInput>(predicateFn: Predicate<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, throwOnIndexOverflow?: boolean): ICollection<TInput | TExtended>;
     crossJoin<TExtended = TInput>(...iterables: Array<Iterable<TExtended>>): ICollection<ICollection<TInput | TExtended>>;
     zip<TExtended>(iterable: Iterable<TExtended>): ICollection<RecordItem<TInput, TExtended>>;
-    sort(compare?: Comparator<TInput>): ICollection<TInput>;
+    sort(comparator?: Comparator<TInput>): ICollection<TInput>;
     reverse(settings?: ReverseSettings): ICollection<TInput>;
     shuffle(): ICollection<TInput>;
     first<TOutput extends TInput>(settings?: FindSettings<TInput, ICollection<TInput>, TOutput>): TOutput | null;
@@ -71,19 +79,20 @@ export declare class IterableCollection<TInput> implements ICollection<TInput> {
     last<TOutput extends TInput>(settings?: FindSettings<TInput, ICollection<TInput>, TOutput>): TOutput | null;
     lastOr<TOutput extends TInput, TExtended = TInput>(settings: FindOrSettings<TInput, ICollection<TInput>, TOutput, TExtended>): TOutput | TExtended;
     lastOrFail<TOutput extends TInput>(settings?: FindSettings<TInput, ICollection<TInput>, TOutput>): TOutput;
-    before(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): TInput | null;
-    beforeOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): TInput | TExtended;
-    beforeOrFail(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): TInput;
-    after(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): TInput | null;
-    afterOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): TInput | TExtended;
-    afterOrFail(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): TInput;
-    sole<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, throwOnNumberLimit?: boolean): TOutput;
+    before(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): TInput | null;
+    beforeOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): TInput | TExtended;
+    beforeOrFail(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): TInput;
+    after(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): TInput | null;
+    afterOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): TInput | TExtended;
+    afterOrFail(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): TInput;
+    sole<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, throwOnIndexOverflow?: boolean): TOutput;
     nth(step: number): ICollection<TInput>;
-    count(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): number;
-    size(throwOnNumberLimit?: boolean): number;
-    empty(): boolean;
-    notEmpty(): boolean;
-    search(filter: Filter<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): number;
-    forEach(callback: ForEach<TInput, ICollection<TInput>>, throwOnNumberLimit?: boolean): void;
+    count(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): number;
+    size(throwOnIndexOverflow?: boolean): number;
+    isEmpty(): boolean;
+    isNotEmpty(): boolean;
+    searchFirst(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): number;
+    searchLast(predicateFn: Predicate<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): number;
+    forEach(callback: ForEach<TInput, ICollection<TInput>>, throwOnIndexOverflow?: boolean): void;
     toArray(): TInput[];
 }

package/dist/types/collection/list-collection/list-collection.d.ts

@@ -1,39 +1,46 @@
-import { type Collapse, type Comparator, type Filter, type FindOrSettings, type FindSettings, type ForEach, type GroupBySettings, type ICollection, type JoinSettings, type Lazyable, type Map, type Modifier, type PageSettings, type RecordItem, type ReduceSettings, type ReverseSettings, type SliceSettings, type SlidingSettings, type Tap, type Transform, type UpdatedItem } from "../../contracts/collection/_module";
-import { EnsureType } from "../../types";
 /**
- * All methods in ListCollection are eager and therefore will run immediately.
- * @group Collections
+ * @module Collections
+ */
+import { type Collapse, type Comparator, type Predicate, type FindOrSettings, type FindSettings, type ForEach, type GroupBySettings, type CountBySettings, type UniqueSettings, type ICollection, type JoinSettings, type Lazyable, type Map, type Modifier, type PageSettings, type RecordItem, type ReduceSettings, type ReverseSettings, type SliceSettings, type SlidingSettings, type Tap, type Transform, type UpdatedItem } from "../../contracts/collection/_module";
+import { EnsureType } from "../../_shared/types";
+/**
+ * All methods in <i>ListCollection</i> are executed eagerly. The <i>throwOnIndexOverflow</i> parameter in the <i>ListCollection</i> methods doesnt have any affect.
+ * @group Adapters
  */
 export declare class ListCollection<TInput> implements ICollection<TInput> {
     private array;
+    /**
+     * The <i>constructor</i> takes an <i>{@link Iterable}</i>.
+     */
     constructor(iterable?: Iterable<TInput>);
     [Symbol.iterator](): Iterator<TInput>;
-    iterator(): Iterator<TInput, void>;
-    entries(_throwOnNumberLimit?: boolean): ICollection<RecordItem<number, TInput>>;
-    keys(_throwOnNumberLimit?: boolean): ICollection<number>;
+    toIterator(): Iterator<TInput, void>;
+    entries(_throwOnIndexOverflow?: boolean): ICollection<RecordItem<number, TInput>>;
+    keys(_throwOnIndexOverflow?: boolean): ICollection<number>;
     values(): ICollection<TInput>;
-    filter<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, _throwOnNumberLimit?: boolean): ICollection<TOutput>;
-    map<TOutput>(map: Map<TInput, ICollection<TInput>, TOutput>, _throwOnNumberLimit?: boolean): ICollection<TOutput>;
+    filter<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, _throwOnIndexOverflow?: boolean): ICollection<TOutput>;
+    reject<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, _throwOnIndexOverflow?: boolean): ICollection<Exclude<TInput, TOutput>>;
+    map<TOutput>(mapFn: Map<TInput, ICollection<TInput>, TOutput>, _throwOnIndexOverflow?: boolean): ICollection<TOutput>;
     reduce<TOutput = TInput>(settings: ReduceSettings<TInput, ICollection<TInput>, TOutput>): TOutput;
-    join(settings?: JoinSettings): string;
+    join(settings?: JoinSettings): EnsureType<TInput, string>;
     collapse(): ICollection<Collapse<TInput>>;
-    flatMap<TOutput>(map: Map<TInput, ICollection<TInput>, Iterable<TOutput>>, _throwOnNumberLimit?: boolean): ICollection<TOutput>;
-    update<TFilterOutput extends TInput, TMapOutput>(filter: Filter<TInput, ICollection<TInput>, TFilterOutput>, map: Map<TFilterOutput, ICollection<TInput>, TMapOutput>, _throwOnNumberLimit?: boolean): ICollection<UpdatedItem<TInput, TFilterOutput, TMapOutput>>;
+    flatMap<TOutput>(mapFn: Map<TInput, ICollection<TInput>, Iterable<TOutput>>, _throwOnIndexOverflow?: boolean): ICollection<TOutput>;
+    update<TFilterOutput extends TInput, TMapOutput>(predicateFn: Predicate<TInput, ICollection<TInput>, TFilterOutput>, mapFn: Map<TFilterOutput, ICollection<TInput>, TMapOutput>, _throwOnIndexOverflow?: boolean): ICollection<UpdatedItem<TInput, TFilterOutput, TMapOutput>>;
     page(settings: PageSettings): ICollection<TInput>;
     sum(): EnsureType<TInput, number>;
     average(): EnsureType<TInput, number>;
-    median(_throwOnNumberLimit?: boolean): EnsureType<TInput, number>;
+    median(_throwOnIndexOverflow?: boolean): EnsureType<TInput, number>;
     min(): EnsureType<TInput, number>;
     max(): EnsureType<TInput, number>;
-    percentage(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): number;
-    some<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, _throwOnNumberLimit?: boolean): boolean;
-    every<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, _throwOnNumberLimit?: boolean): boolean;
-    take(limit: number, _throwOnNumberLimit?: boolean): ICollection<TInput>;
-    takeUntil(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): ICollection<TInput>;
-    takeWhile(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): ICollection<TInput>;
-    skip(offset: number, _throwOnNumberLimit?: boolean): ICollection<TInput>;
-    skipUntil(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): ICollection<TInput>;
-    skipWhile(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): ICollection<TInput>;
+    percentage(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): number;
+    some<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, _throwOnIndexOverflow?: boolean): boolean;
+    every<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, _throwOnIndexOverflow?: boolean): boolean;
+    take(limit: number, _throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    takeUntil(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    takeWhile(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    skip(offset: number, _throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    skipUntil(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): ICollection<TInput>;
+    skipWhile(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): ICollection<TInput>;
     when<TExtended = TInput>(condition: boolean, callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
     whenEmpty<TExtended = TInput>(callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
     whenNot<TExtended = TInput>(condition: boolean, callback: Modifier<ICollection<TInput>, ICollection<TExtended>>): ICollection<TInput | TExtended>;
@@ -41,25 +48,25 @@ export declare class ListCollection<TInput> implements ICollection<TInput> {
     pipe<TOutput = TInput>(callback: Transform<ICollection<TInput>, TOutput>): TOutput;
     tap(callback: Tap<ICollection<TInput>>): ICollection<TInput>;
     chunk(chunkSize: number): ICollection<ICollection<TInput>>;
-    chunkWhile(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): ICollection<ICollection<TInput>>;
-    split(chunkAmount: number, _throwOnNumberLimit?: boolean): ICollection<ICollection<TInput>>;
-    partition(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): ICollection<ICollection<TInput>>;
+    chunkWhile(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): ICollection<ICollection<TInput>>;
+    split(chunkAmount: number, _throwOnIndexOverflow?: boolean): ICollection<ICollection<TInput>>;
+    partition(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): ICollection<ICollection<TInput>>;
     sliding(settings: SlidingSettings): ICollection<ICollection<TInput>>;
     groupBy<TOutput = TInput>(settings?: GroupBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, ICollection<TInput>>>;
-    countBy<TOutput = TInput>(settings?: GroupBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, number>>;
-    unique<TOutput = TInput>(settings?: GroupBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
-    difference<TOutput = TInput>(iterable: Iterable<TInput>, map?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
+    countBy<TOutput = TInput>(settings?: CountBySettings<TInput, ICollection<TInput>, TOutput>): ICollection<RecordItem<TOutput, number>>;
+    unique<TOutput = TInput>(settings?: UniqueSettings<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
+    difference<TOutput = TInput>(iterable: Iterable<TInput>, selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<TInput>;
     repeat(amount: number): ICollection<TInput>;
     padStart<TExtended = TInput>(maxLength: number, fillItems: Iterable<TExtended>): ICollection<TInput | TExtended>;
     padEnd<TExtended = TInput>(maxLength: number, fillItems: Iterable<TExtended>): ICollection<TInput | TExtended>;
     slice(settings?: SliceSettings): ICollection<TInput>;
     prepend<TExtended = TInput>(iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
     append<TExtended = TInput>(iterable: Iterable<TInput | TExtended>): ICollection<TInput | TExtended>;
-    insertBefore<TExtended = TInput>(filter: Filter<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, _throwOnNumberLimit?: boolean): ICollection<TInput | TExtended>;
-    insertAfter<TExtended = TInput>(filter: Filter<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, _throwOnNumberLimit?: boolean): ICollection<TInput | TExtended>;
+    insertBefore<TExtended = TInput>(predicateFn: Predicate<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, _throwOnIndexOverflow?: boolean): ICollection<TInput | TExtended>;
+    insertAfter<TExtended = TInput>(predicateFn: Predicate<TInput, ICollection<TInput>>, iterable: Iterable<TInput | TExtended>, _throwOnIndexOverflow?: boolean): ICollection<TInput | TExtended>;
     crossJoin<TExtended = TInput>(...iterables: Array<Iterable<TExtended>>): ICollection<ICollection<TInput | TExtended>>;
     zip<TExtended>(iterable: Iterable<TExtended>): ICollection<RecordItem<TInput, TExtended>>;
-    sort(compare?: Comparator<TInput>): ICollection<TInput>;
+    sort(comparator?: Comparator<TInput>): ICollection<TInput>;
     reverse(_settings?: ReverseSettings): ICollection<TInput>;
     shuffle(): ICollection<TInput>;
     first<TOutput extends TInput>(settings?: FindSettings<TInput, ICollection<TInput>, TOutput>): TOutput | null;
@@ -68,19 +75,20 @@ export declare class ListCollection<TInput> implements ICollection<TInput> {
     last<TOutput extends TInput>(settings?: FindSettings<TInput, ICollection<TInput>, TOutput>): TOutput | null;
     lastOr<TOutput extends TInput, TExtended = TInput>(settings: FindOrSettings<TInput, ICollection<TInput>, TOutput, TExtended>): TOutput | TExtended;
     lastOrFail<TOutput extends TInput>(settings?: FindSettings<TInput, ICollection<TInput>, TOutput>): TOutput;
-    before(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): TInput | null;
-    beforeOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): TInput | TExtended;
-    beforeOrFail(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): TInput;
-    after(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): TInput | null;
-    afterOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): TInput | TExtended;
-    afterOrFail(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): TInput;
-    sole<TOutput extends TInput>(filter: Filter<TInput, ICollection<TInput>, TOutput>, _throwOnNumberLimit?: boolean): TOutput;
+    before(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): TInput | null;
+    beforeOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): TInput | TExtended;
+    beforeOrFail(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): TInput;
+    after(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): TInput | null;
+    afterOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): TInput | TExtended;
+    afterOrFail(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): TInput;
+    sole<TOutput extends TInput>(predicateFn: Predicate<TInput, ICollection<TInput>, TOutput>, _throwOnIndexOverflow?: boolean): TOutput;
     nth(step: number): ICollection<TInput>;
-    count(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): number;
-    size(_throwOnNumberLimit?: boolean): number;
-    empty(): boolean;
-    notEmpty(): boolean;
-    search(filter: Filter<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): number;
-    forEach(callback: ForEach<TInput, ICollection<TInput>>, _throwOnNumberLimit?: boolean): void;
+    count(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): number;
+    size(_throwOnIndexOverflow?: boolean): number;
+    isEmpty(): boolean;
+    isNotEmpty(): boolean;
+    searchFirst(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): number;
+    searchLast(predicateFn: Predicate<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): number;
+    forEach(callback: ForEach<TInput, ICollection<TInput>>, _throwOnIndexOverflow?: boolean): void;
     toArray(): TInput[];
 }

package/dist/types/contracts/_module.d.ts

@@ -1 +1 @@
-export * from "../collection/_module";
+export * from "../contracts/collection/_module";

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

@@ -1,3 +1,6 @@
+/**
+ * @module Collections
+ */
 export * from "../../contracts/collection/_shared";
 export * from "../../contracts/collection/collection.contract";
 export * from "../../contracts/collection/async-collection.contract";