@daiso-tech/core 0.33.0 → 0.35.0

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

@@ -6,32 +6,32 @@ import type { ISerializable } from "../../serde/contracts/_module-exports.js";
 import type { Lazyable } from "../../utilities/_module-exports.js";
 export type Collapse<TValue> = TValue extends Array<infer TItem> | Iterable<infer TItem> | ICollection<infer TItem> ? TItem : TValue;
 /**
- * The <i>ICollection</i> contract offers a fluent and efficient approach to working with {@link Iterable} objects.
- * <i>ICollection</i> is immutable.
+ * The `ICollection` contract offers a fluent and efficient approach to working with {@link Iterable | `Iterable`} objects.
+ * `ICollection` is immutable.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/collection/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/collection/contracts"`
  * @group Contracts
  * @throws {UnexpectedCollectionError} {@link UnexpectedCollectionError}
  */
 export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TInput[]> & {
     /**
-     * The <i>toIterator</i> method converts the collection to a new iterator.
+     * The `toIterator` 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.
+     * The `entries` returns an ICollection of key, value pairs for every entry in the collection.
      */
     entries(): ICollection<[number, TInput]>;
     /**
-     * The <i>keys</i> method returns an ICollection of keys in the collection.
+     * The `keys` method returns an ICollection of keys in the collection.
      */
     keys(): ICollection<number>;
     /**
-     * The <i>values</i> method returns a copy of the collection.
+     * The `values` 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>.
+     * The `filter` method filters the collection using `predicateFn`, keeping only those items that pass `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -48,7 +48,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     filter<TOutput extends TInput>(predicateFn: PredicateInvokable<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>.
+     * The `reject` method filters the collection using `predicateFn`, keeping only those items that not pass `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -65,8 +65,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     reject<TOutput extends TInput>(predicateFn: PredicateInvokable<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.
+     * The `map` method iterates through the collection and passes each item to `mapFn`.
+     * The `mapFn` is free to modify the item and return it, thus forming a new collection of modified items.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -83,7 +83,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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 `reduce` method executes ` reduceFn ` 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
      * ```ts
@@ -121,7 +121,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
     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.
+     * The `join` method joins the collection's items with ` separator `. An error will be thrown when if a none string item is encounterd.
      * @throws {TypeCollectionError}
      * @example
      * ```ts
@@ -151,7 +151,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     join(separator?: string): Extract<TInput, string>;
     /**
-     * The <i>collapse</i> method collapses a collection of iterables into a single, flat collection.
+     * The `collapse` method collapses a collection of iterables into a single, flat collection.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -168,8 +168,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `flatMap` method returns a new array formed by applying `mapFn` to each item of the array, and then collapses the result by one level.
+     * It is identical to a `map` method followed by a `collapse` method.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -186,7 +186,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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>.
+     * The `change` method changes only the items that passes `predicateFn` using `mapFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -203,7 +203,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     change<TFilterOutput extends TInput, TMapOutput>(predicateFn: PredicateInvokable<TInput, ICollection<TInput>, TFilterOutput>, mapFn: Map<TFilterOutput, ICollection<TInput>, TMapOutput>): ICollection<TInput | TFilterOutput | TMapOutput>;
     /**
-     * The <i>set</i> method changes a item by i>index</i> using <i>value</i>.
+     * The `set` method changes a item by i>index` using `value`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -233,7 +233,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     set(index: number, value: TInput | Map<TInput, ICollection<TInput>, TInput>): ICollection<TInput>;
     /**
-     * The <i>get</i> method returns the item by index. If the item is not found null will returned.
+     * The `get` method returns the item by index. If the item is not found null will returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -252,7 +252,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     get(index: number): TInput | null;
     /**
-     * The <i>getOrFail</i> method returns the item by index. If the item is not found an error will be thrown.
+     * The `getOrFail` method returns the item by index. If the item is not found an error will be thrown.
      * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
      * @example
      * ```ts
@@ -272,7 +272,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     getOrFail(index: number): TInput;
     /**
-     * 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>.
+     * The `page` method returns a new collection containing the items that would be present on ` page ` with custom ` pageSize `.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -289,7 +289,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `sum` 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.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      * @throws {EmptyCollectionError} {@link EmptyCollectionError}
@@ -308,7 +308,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     sum(): Extract<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.
+     * The `average` 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.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      * @throws {EmptyCollectionError} {@link EmptyCollectionError}
@@ -327,7 +327,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     average(): Extract<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.
+     * The `median` 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.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      * @throws {EmptyCollectionError} {@link EmptyCollectionError}
@@ -346,7 +346,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     median(): Extract<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.
+     * The `min` 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.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      * @throws {EmptyCollectionError} {@link EmptyCollectionError}
@@ -365,7 +365,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     min(): Extract<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.
+     * The `max` 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.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      * @throws {EmptyCollectionError} {@link EmptyCollectionError}
@@ -384,7 +384,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     max(): Extract<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>.
+     * The `percentage` method may be used to quickly determine the percentage of items in the collection that pass `predicateFn`.
      * If the collection is empty an error will also be thrown.
      * @throws {EmptyCollectionError} {@link EmptyCollectionError}
      * @example
@@ -402,7 +402,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     percentage(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): number;
     /**
-     * The <i>some</i> method determines whether at least one item in the collection matches <i>predicateFn</i>.
+     * The `some` method determines whether at least one item in the collection matches `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -418,7 +418,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     some<TOutput extends TInput>(predicateFn: PredicateInvokable<TInput, ICollection<TInput>, TOutput>): boolean;
     /**
-     * The <i>every</i> method determines whether all items in the collection matches <i>predicateFn</i>.
+     * The `every` method determines whether all items in the collection matches `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -434,7 +434,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     every<TOutput extends TInput>(predicateFn: PredicateInvokable<TInput, ICollection<TInput>, TOutput>): boolean;
     /**
-     * The <i>take</i> method takes the first <i>limit</i> items.
+     * The `take` method takes the first `limit` items.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -465,7 +465,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     take(limit: number): ICollection<TInput>;
     /**
-     * The <i>takeUntil</i> method takes items until <i>predicateFn</i> returns true.
+     * The `takeUntil` method takes items until `predicateFn` returns true.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -482,7 +482,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     takeUntil(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): ICollection<TInput>;
     /**
-     * The <i>takeWhile</i> method takes items until <i>predicateFn</i> returns false.
+     * The `takeWhile` method takes items until `predicateFn` returns false.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -499,7 +499,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     takeWhile(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): ICollection<TInput>;
     /**
-     * The <i>skip</i> method skips the first <i>offset</i> items.
+     * The `skip` method skips the first `offset` items.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -516,7 +516,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     skip(offset: number): ICollection<TInput>;
     /**
-     * The <i>skipUntil</i> method skips items until <i>predicateFn</i> returns true.
+     * The `skipUntil` method skips items until `predicateFn` returns true.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -533,7 +533,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     skipUntil(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): ICollection<TInput>;
     /**
-     * The <i>skipWhile</i> method skips items until <i>predicateFn</i> returns false.
+     * The `skipWhile` method skips items until `predicateFn` returns false.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -550,7 +550,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     skipWhile(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): ICollection<TInput>;
     /**
-     * The <i>when</i> method will execute <i>callback</i> when <i>condition</i> evaluates to true.
+     * The `when` method will execute `callback` when `condition` evaluates to true.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -568,7 +568,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `whenEmpty` method will execute `callback` when the collection is empty.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -598,7 +598,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `whenNot` method will execute `callback` when `condition` evaluates to false.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -615,7 +615,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `whenNotEmpty` method will execute `callback` when the collection is not empty.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -644,7 +644,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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>.
+     * The `pipe` method passes the orignal collection to `callback` and returns the result from `callback`.
      * This method is useful when you want compose multiple smaller functions.
      * @example
      * ```ts
@@ -674,7 +674,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `tap` method passes a copy of the original collection to `callback`, allowing you to do something with the items while not affecting the original collection.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -694,8 +694,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `chunk` method breaks the collection into multiple, smaller collections of size `chunkSize`.
+     * If `chunkSize` is not divisible with total number of items then the last chunk will contain the remaining items.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -711,8 +711,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `chunkWhile` method breaks the collection into multiple, smaller collections based on the evaluation of `predicateFn`.
+     * The chunk variable passed to the `predicateFn` may be used to inspect the previous item.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -732,7 +732,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     chunkWhile(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): ICollection<ICollection<TInput>>;
     /**
-     * The <i>split</i> method breaks a collection evenly into <i>chunkAmount</i> of chunks.
+     * The `split` method breaks a collection evenly into `chunkAmount` of chunks.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -778,7 +778,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `partition` method is used to separate items that pass `predicateFn` from those that do not.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -796,7 +796,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     partition(predicateFn: PredicateInvokable<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.
+     * The `sliding` method returns a new collection of chunks representing a "sliding window" view of the items in the collection.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -814,7 +814,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     sliding(chunkSize: number, step?: number): ICollection<ICollection<TInput>>;
     /**
-     * The <i>groupBy</i> method groups the collection's items by <i> selectFn </i>.
+     * The `groupBy` method groups the collection's items by ` selectFn `.
      * By default the equality check occurs on the item.
      * @example
      * ```ts
@@ -869,7 +869,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     groupBy<TOutput = TInput>(selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<[TOutput, ICollection<TInput>]>;
     /**
-     * The <i>countBy</i> method counts the occurrences of values in the collection by <i> selectFn </i>.
+     * The `countBy` method counts the occurrences of values in the collection by ` selectFn `.
      * By default the equality check occurs on the item.
      * @example
      * ```ts
@@ -908,7 +908,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     countBy<TOutput = TInput>(selectFn?: Map<TInput, ICollection<TInput>, TOutput>): ICollection<[TOutput, number]>;
     /**
-     * The <i>unique</i> method removes all duplicate values from the collection by <i> selectFn </i>.
+     * The `unique` method removes all duplicate values from the collection by ` selectFn `.
      * By default the equality check occurs on the item.
      * @example
      * ```ts
@@ -954,7 +954,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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>.
+     * The `difference` method will return the values in the original collection that are not present in `iterable`.
      * By default the equality check occurs on the item.
      * @example
      * ```ts
@@ -1006,7 +1006,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `repeat` method will repeat the original collection `amount` times.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1023,7 +1023,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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 `padStart` method pads this collection with `fillItems` until the resulting collection size reaches `maxLength`.
      * The padding is applied from the start of this collection.
      * @example
      * ```ts
@@ -1071,7 +1071,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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 `padEnd` method pads this collection with `fillItems` until the resulting collection size reaches `maxLength`.
      * The padding is applied from the end of this collection.
      * @example
      * ```ts
@@ -1129,8 +1129,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `slice` method creates porition of the original collection selected from `start` and `end`
+     * where `start` and `end` (end not included) represent the index of items in the collection.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1212,7 +1212,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     slice(start?: number, end?: number): ICollection<TInput>;
     /**
-     * The <i>prepend</i> method adds <i>iterable</i> to the beginning of the collection.
+     * The `prepend` method adds `iterable` to the beginning of the collection.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1229,7 +1229,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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.
+     * The `append` method adds `iterable` to the end of the collection.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1246,7 +1246,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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>.
+     * The `insertBefore` method adds `iterable` before the first item that matches `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1263,7 +1263,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     insertBefore<TExtended = TInput>(predicateFn: PredicateInvokable<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>.
+     * The `insertAfter` method adds `iterable` after the first item that matches `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1280,7 +1280,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     insertAfter<TExtended = TInput>(predicateFn: PredicateInvokable<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.
+     * The `crossJoin` method cross joins the collection's values among `iterables`, returning a Cartesian product with all possible permutations.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1325,7 +1325,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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 `zip` method merges together the values of `iterable` with the values of the collection at their corresponding index.
      * The returned collection has size of the shortest collection.
      * @example
      * ```ts
@@ -1369,7 +1369,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     zip<TExtended>(iterable: Iterable<TExtended>): ICollection<[TInput, TExtended]>;
     /**
-     * The <i>sort</i> method sorts the collection. You can provide a <i>comparator</i> function.
+     * The `sort` method sorts the collection. You can provide a `comparator` function.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1414,8 +1414,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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>.
+     * The `reverse` method will reverse the order of the collection.
+     * The reversing of the collection will be applied in chunks that are the size of ` chunkSize `.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1432,12 +1432,12 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     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>.
+     * The `shuffle` method randomly shuffles the items in the collection. You can provide a custom Math.random function by passing in `mathRandom`.
      */
     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.
+     * The `first` method returns the first item in the collection that passes ` predicateFn `.
+     * By default it will get the first item. If the collection is empty or no items passes ` predicateFn ` than null i returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1478,8 +1478,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     first<TOutput extends TInput>(predicateFn?: PredicateInvokable<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>.
+     * The `firstOr` method returns the first item in the collection that passes ` predicateFn `
+     * By default it will get the first item. If the collection is empty or no items passes ` predicateFn ` than ` defaultValue `.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1531,8 +1531,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     firstOr<TOutput extends TInput, TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn?: PredicateInvokable<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.
+     * The `firstOrFail` method returns the first item in the collection that passes ` predicateFn `.
+     * By default it will get the first item. If the collection is empty or no items passes ` predicateFn ` than error is thrown.
      * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
      * @example
      * ```ts
@@ -1573,8 +1573,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     firstOrFail<TOutput extends TInput>(predicateFn?: PredicateInvokable<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.
+     * The `last` method returns the last item in the collection that passes ` predicateFn `.
+     * By default it will get the last item. If the collection is empty or no items passes ` predicateFn ` than null i returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1614,8 +1614,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     last<TOutput extends TInput>(predicateFn?: PredicateInvokable<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>.
+     * The `lastOr` method returns the last item in the collection that passes ` predicateFn `.
+     * By default it will get the last item. If the collection is empty or no items passes ` predicateFn ` than ` defaultValue `.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1667,8 +1667,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     lastOr<TOutput extends TInput, TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn?: PredicateInvokable<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.
+     * The `lastOrFail` method returns the last item in the collection that passes ` predicateFn `.
+     * By default it will get the last item. If the collection is empty or no items passes ` predicateFn ` than error is thrown.
      * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
      * @example
      * ```ts
@@ -1709,8 +1709,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     lastOrFail<TOutput extends TInput>(predicateFn?: PredicateInvokable<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.
+     * The `before` method returns the item that comes before the first item that matches `predicateFn`.
+     * If the `predicateFn` does not match or matches the first item then null is returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1738,8 +1738,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     before(predicateFn: PredicateInvokable<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.
+     * The `beforeOr` method returns the item that comes before the first item that matches `predicateFn`.
+     * If the collection is empty or the `predicateFn` does not match or matches the first item then `defaultValue` is returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1779,8 +1779,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     beforeOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: PredicateInvokable<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.
+     * The `beforeOrFail` method returns the item that comes before the first item that matches `predicateFn`.
+     * If the collection is empty or the `predicateFn` does not match or matches the first item then an error is thrown.
      * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
      * @example
      * ```ts
@@ -1809,8 +1809,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     beforeOrFail(predicateFn: PredicateInvokable<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.
+     * The `after` method returns the item that comes after the first item that matches `predicateFn`.
+     * If the collection is empty or the `predicateFn` does not match or matches the last item then null is returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1838,8 +1838,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     after(predicateFn: PredicateInvokable<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.
+     * The `afterOr` method returns the item that comes after the first item that matches `predicateFn`.
+     * If the collection is empty or the `predicateFn` does not match or matches the last item then `defaultValue` is returned.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1879,8 +1879,8 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     afterOr<TExtended = TInput>(defaultValue: Lazyable<TExtended>, predicateFn: PredicateInvokable<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.
+     * The `afterOrFail` method returns the item that comes after the first item that matches `predicateFn`.
+     * If the collection is empty or the `predicateFn` does not match or matches the last item then an error is thrown.
      * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
      * @example
      * ```ts
@@ -1909,7 +1909,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     afterOrFail(predicateFn: PredicateInvokable<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.
+     * The `sole` method returns the first item in the collection that passes `predicateFn`, but only if `predicateFn` matches exactly one item.
      * If no items matches or multiple items are found an error will be thrown.
      * @throws {ItemNotFoundCollectionError} {@link ItemNotFoundCollectionError}
      * @throws {MultipleItemsFoundCollectionError} {@link MultipleItemsFoundCollectionError}
@@ -1952,7 +1952,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     sole<TOutput extends TInput>(predicateFn: PredicateInvokable<TInput, ICollection<TInput>, TOutput>): TOutput;
     /**
-     * The <i>nth</i> method creates a new collection consisting of every n-th item.
+     * The `nth` method creates a new collection consisting of every n-th item.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1969,7 +1969,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     nth(step: number): ICollection<TInput>;
     /**
-     * The <i>count</i> method returns the total number of items in the collection that passes <i>predicateFn</i>.
+     * The `count` method returns the total number of items in the collection that passes `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -1985,19 +1985,19 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     count(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): number;
     /**
-     * The <i>size</i> returns the size of the collection.
+     * The `size` returns the size of the collection.
      */
     size(): number;
     /**
-     * The <i>isEmpty</i> returns true if the collection is empty.
+     * The `isEmpty` returns true if the collection is empty.
      */
     isEmpty(): boolean;
     /**
-     * The <i>isNotEmpty</i> returns true if the collection is not empty.
+     * The `isNotEmpty` returns true if the collection is not empty.
      */
     isNotEmpty(): boolean;
     /**
-     * The <i>searchFirst</i> return the index of the first item that matches <i>predicateFn</i>.
+     * The `searchFirst` return the index of the first item that matches `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -2013,7 +2013,7 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     searchFirst(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): number;
     /**
-     * The <i>searchLast</i> return the index of the last item that matches <i>predicateFn</i>.
+     * The `searchLast` return the index of the last item that matches `predicateFn`.
      * @example
      * ```ts
      * import type { ICollection } from "@daiso-tech/core";
@@ -2029,21 +2029,21 @@ export type ICollection<TInput = unknown> = Iterable<TInput> & ISerializable<TIn
      */
     searchLast(predicateFn: PredicateInvokable<TInput, ICollection<TInput>>): number;
     /**
-     * The <i>forEach</i> method iterates through all items in the collection.
+     * The `forEach` method iterates through all items in the collection.
      */
     forEach(callback: ForEach<TInput, ICollection<TInput>>): void;
     /**
-     * The <i>toArray</i> method converts the collection to a new <i>{@link Array}</i>.
+     * The `toArray` method converts the collection to a new {@link Array | `Array`}.
      */
     toArray(): TInput[];
     /**
-     * The <i>toRecord</i> method converts the collection to a new <i>{@link Record}</i>.
+     * The `toRecord` method converts the collection to a new {@link Record | `Record`}.
      * An error will be thrown if item is not a tuple of size 2 where the first element is a string or a number.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      */
     toRecord(): EnsureRecord<TInput>;
     /**
-     * The <i>toMap</i> method converts the collection to a new <i>{@link Map}</i>.
+     * The `toMap` method converts the collection to a new {@link Map | `Map`}.
      * An error will be thrown if item is not a tuple of size 2.
      * @throws {TypeCollectionError} {@link TypeCollectionError}
      */