es-toolkit 1.47.0-dev.1841 → 1.47.0-dev.1843

package/dist/compat/array/orderBy.js

@@ -10,11 +10,11 @@ const require_isKey = require("../_internal/isKey.js");
 * If values for a key are equal, it moves to the next key to determine the order.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | object | null | undefined} collection - The array of objects to be sorted.
-* @param {Criterion<T> | Array<Criterion<T>>} criteria - An array of criteria (property names or property paths or custom key functions) to sort by.
-* @param {unknown | unknown[]} orders - An array of order directions ('asc' for ascending or 'desc' for descending).
-* @param {unknown} [guard] Enables use as an iteratee for methods like `_.reduce`.
-* @returns {T[]} - The sorted array.
+* @param collection - The array of objects to be sorted.
+* @param criteria - An array of criteria (property names or property paths or custom key functions) to sort by.
+* @param orders - An array of order directions ('asc' for ascending or 'desc' for descending).
+* @param [guard] Enables use as an iteratee for methods like `_.reduce`.
+* @returns The sorted array.
 *
 * @example
 * // Sort an array of objects by 'user' in ascending order and 'age' in descending order.

package/dist/compat/array/orderBy.mjs

@@ -10,11 +10,11 @@ import { isKey } from "../_internal/isKey.mjs";
 * If values for a key are equal, it moves to the next key to determine the order.
 *
 * @template T - The type of elements in the array.
-* @param {ArrayLike<T> | object | null | undefined} collection - The array of objects to be sorted.
-* @param {Criterion<T> | Array<Criterion<T>>} criteria - An array of criteria (property names or property paths or custom key functions) to sort by.
-* @param {unknown | unknown[]} orders - An array of order directions ('asc' for ascending or 'desc' for descending).
-* @param {unknown} [guard] Enables use as an iteratee for methods like `_.reduce`.
-* @returns {T[]} - The sorted array.
+* @param collection - The array of objects to be sorted.
+* @param criteria - An array of criteria (property names or property paths or custom key functions) to sort by.
+* @param orders - An array of order directions ('asc' for ascending or 'desc' for descending).
+* @param [guard] Enables use as an iteratee for methods like `_.reduce`.
+* @returns The sorted array.
 *
 * @example
 * // Sort an array of objects by 'user' in ascending order and 'age' in descending order.

package/dist/compat/array/partition.d.mts

@@ -8,9 +8,9 @@ import { ValueIteratorTypeGuard } from "../_internal/ValueIteratorTypeGuard.mjs"
  * The predicate is invoked with one argument: (value).
  *
  * @template T, U
- * @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
- * @param {(value: T) => value is U} callback - The function invoked per iteration.
- * @returns {[U[], Array<Exclude<T, U>>]} Returns the array of grouped elements.
+ * @param collection - The collection to iterate over.
+ * @param callback - The function invoked per iteration.
+ * @returns Returns the array of grouped elements.
  *
  * @example
  * partition([1, 2, 3, 4], n => n % 2 === 0);
@@ -23,9 +23,9 @@ declare function partition<T, U extends T>(collection: ArrayLike<T> | null | und
  * The predicate is invoked with one argument: (value).
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
- * @param {((value: T) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T>} callback - The function invoked per iteration.
- * @returns {[T[], T[]]} Returns the array of grouped elements.
+ * @param collection - The collection to iterate over.
+ * @param callback - The function invoked per iteration.
+ * @returns Returns the array of grouped elements.
  *
  * @example
  * partition([1, 2, 3, 4], n => n % 2 === 0);
@@ -38,9 +38,9 @@ declare function partition<T>(collection: ArrayLike<T> | null | undefined, callb
  * The predicate is invoked with one argument: (value).
  *
  * @template T
- * @param {T | null | undefined} collection - The collection to iterate over.
- * @param {((value: T[keyof T]) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T[keyof T]>} callback - The function invoked per iteration.
- * @returns {[Array<T[keyof T]>, Array<T[keyof T]>]} Returns the array of grouped elements.
+ * @param collection - The collection to iterate over.
+ * @param callback - The function invoked per iteration.
+ * @returns Returns the array of grouped elements.
  *
  * @example
  * partition({ a: 1, b: 2, c: 3 }, n => n % 2 === 0);

package/dist/compat/array/partition.d.ts

@@ -8,9 +8,9 @@ import { ValueIteratorTypeGuard } from "../_internal/ValueIteratorTypeGuard.js";
  * The predicate is invoked with one argument: (value).
  *
  * @template T, U
- * @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
- * @param {(value: T) => value is U} callback - The function invoked per iteration.
- * @returns {[U[], Array<Exclude<T, U>>]} Returns the array of grouped elements.
+ * @param collection - The collection to iterate over.
+ * @param callback - The function invoked per iteration.
+ * @returns Returns the array of grouped elements.
  *
  * @example
  * partition([1, 2, 3, 4], n => n % 2 === 0);
@@ -23,9 +23,9 @@ declare function partition<T, U extends T>(collection: ArrayLike<T> | null | und
  * The predicate is invoked with one argument: (value).
  *
  * @template T
- * @param {ArrayLike<T> | null | undefined} collection - The collection to iterate over.
- * @param {((value: T) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T>} callback - The function invoked per iteration.
- * @returns {[T[], T[]]} Returns the array of grouped elements.
+ * @param collection - The collection to iterate over.
+ * @param callback - The function invoked per iteration.
+ * @returns Returns the array of grouped elements.
  *
  * @example
  * partition([1, 2, 3, 4], n => n % 2 === 0);
@@ -38,9 +38,9 @@ declare function partition<T>(collection: ArrayLike<T> | null | undefined, callb
  * The predicate is invoked with one argument: (value).
  *
  * @template T
- * @param {T | null | undefined} collection - The collection to iterate over.
- * @param {((value: T[keyof T]) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T[keyof T]>} callback - The function invoked per iteration.
- * @returns {[Array<T[keyof T]>, Array<T[keyof T]>]} Returns the array of grouped elements.
+ * @param collection - The collection to iterate over.
+ * @param callback - The function invoked per iteration.
+ * @returns Returns the array of grouped elements.
  *
  * @example
  * partition({ a: 1, b: 2, c: 3 }, n => n % 2 === 0);

package/dist/compat/array/partition.js

@@ -8,9 +8,9 @@ const require_iteratee = require("../util/iteratee.js");
 * `predicate` returns falsy for. The predicate is invoked with one argument: (value).
 *
 * @template T
-* @param {ArrayLike<T> | T | null | undefined} source - The array or object to iterate over.
-* @param {((item: T, index: number, arr: any) => unknown) | Partial<T> | [keyof T, unknown] | PropertyKey} [predicate=identity] - The function invoked per iteration.
-* @returns {[T[], T[]]} - Returns the array of grouped elements.
+* @param source - The array or object to iterate over.
+* @param [predicate=identity] - The function invoked per iteration.
+* @returns Returns the array of grouped elements.
 *
 * @example
 * partition([{ a: 1 }, { a: 2 }, { b: 1 }], 'a');

package/dist/compat/array/partition.mjs

@@ -8,9 +8,9 @@ import { iteratee } from "../util/iteratee.mjs";
 * `predicate` returns falsy for. The predicate is invoked with one argument: (value).
 *
 * @template T
-* @param {ArrayLike<T> | T | null | undefined} source - The array or object to iterate over.
-* @param {((item: T, index: number, arr: any) => unknown) | Partial<T> | [keyof T, unknown] | PropertyKey} [predicate=identity] - The function invoked per iteration.
-* @returns {[T[], T[]]} - Returns the array of grouped elements.
+* @param source - The array or object to iterate over.
+* @param [predicate=identity] - The function invoked per iteration.
+* @returns Returns the array of grouped elements.
 *
 * @example
 * partition([{ a: 1 }, { a: 2 }, { b: 1 }], 'a');

package/dist/compat/array/pull.d.mts

@@ -5,9 +5,9 @@
  * **Note:** Unlike `_.without`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {...T[]} values - The values to remove.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];
@@ -23,9 +23,9 @@ declare function pull<T>(array: T[], ...values: T[]): T[];
  * **Note:** Unlike `_.without`, this method mutates `array`.
  *
  * @template L
- * @param {L} array - The array to modify.
- * @param {...L[0][]} values - The values to remove.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];

package/dist/compat/array/pull.d.ts

@@ -5,9 +5,9 @@
  * **Note:** Unlike `_.without`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {...T[]} values - The values to remove.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];
@@ -23,9 +23,9 @@ declare function pull<T>(array: T[], ...values: T[]): T[];
  * **Note:** Unlike `_.without`, this method mutates `array`.
  *
  * @template L
- * @param {L} array - The array to modify.
- * @param {...L[0][]} values - The values to remove.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];

package/dist/compat/array/pull.js

@@ -7,9 +7,9 @@ const require_pull = require("../../array/pull.js");
 * If you want to remove values without modifying the original array, use `difference`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {...unknown[]} valuesToRemove - The values to remove from the array.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/compat/array/pull.mjs

@@ -7,9 +7,9 @@ import { pull as pull$1 } from "../../array/pull.mjs";
 * If you want to remove values without modifying the original array, use `difference`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {...unknown[]} valuesToRemove - The values to remove from the array.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/compat/array/pullAll.d.mts

@@ -8,9 +8,9 @@ import { RejectReadonly } from "../_internal/RejectReadonly.mjs";
  * **Note:** Unlike `_.difference`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<T>} [values] - The values to remove.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];
@@ -26,9 +26,9 @@ declare function pullAll<T>(array: T[], values?: ArrayLike<T>): T[];
  * **Note:** Unlike `_.difference`, this method mutates `array`.
  *
  * @template L
- * @param {RejectReadonly<L>} array - The array to modify.
- * @param {List<L[0]>} [values] - The values to remove.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];

package/dist/compat/array/pullAll.d.ts

@@ -8,9 +8,9 @@ import { RejectReadonly } from "../_internal/RejectReadonly.js";
  * **Note:** Unlike `_.difference`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<T>} [values] - The values to remove.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];
@@ -26,9 +26,9 @@ declare function pullAll<T>(array: T[], values?: ArrayLike<T>): T[];
  * **Note:** Unlike `_.difference`, this method mutates `array`.
  *
  * @template L
- * @param {RejectReadonly<L>} array - The array to modify.
- * @param {List<L[0]>} [values] - The values to remove.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [1, 2, 3, 1, 2, 3];

package/dist/compat/array/pullAll.js

@@ -7,9 +7,9 @@ const require_pull = require("../../array/pull.js");
 * If you want to remove values without modifying the original array, use `difference`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {ArrayLike<T>} valuesToRemove - The values to remove from the array.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/compat/array/pullAll.mjs

@@ -7,9 +7,9 @@ import { pull } from "../../array/pull.mjs";
 * If you want to remove values without modifying the original array, use `difference`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {ArrayLike<T>} valuesToRemove - The values to remove from the array.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * const numbers = [1, 2, 3, 4, 5, 2, 4];

package/dist/compat/array/pullAllBy.d.mts

@@ -10,10 +10,10 @@ import { RejectReadonly } from "../_internal/RejectReadonly.mjs";
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<T>} [values] - The values to remove.
- * @param {((value: T) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T>} [iteratee] - The iteratee invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [iteratee] - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
@@ -30,10 +30,10 @@ declare function pullAllBy<T>(array: T[], values?: ArrayLike<T>, iteratee?: Valu
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template L
- * @param {RejectReadonly<L>} array - The array to modify.
- * @param {ArrayLike<L[0]>} [values] - The values to remove.
- * @param {ValueIteratee<L[0]>} [iteratee] - The iteratee invoked per element.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [iteratee] - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
@@ -50,10 +50,10 @@ declare function pullAllBy<L extends MutableList<any>>(array: RejectReadonly<L>,
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template T, U
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<U>} values - The values to remove.
- * @param {((value: T | U) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T | U>} iteratee - The iteratee invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
@@ -70,10 +70,10 @@ declare function pullAllBy<T, U>(array: T[], values: ArrayLike<U>, iteratee: Val
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template L, U
- * @param {L} array - The array to modify.
- * @param {ArrayLike<U>} values - The values to remove.
- * @param {((value: L[0] | U) => unknown) | PropertyKey | [PropertyKey, any] | Partial<L[0] | U>} iteratee - The iteratee invoked per element.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];

package/dist/compat/array/pullAllBy.d.ts

@@ -10,10 +10,10 @@ import { RejectReadonly } from "../_internal/RejectReadonly.js";
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<T>} [values] - The values to remove.
- * @param {((value: T) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T>} [iteratee] - The iteratee invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [iteratee] - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
@@ -30,10 +30,10 @@ declare function pullAllBy<T>(array: T[], values?: ArrayLike<T>, iteratee?: Valu
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template L
- * @param {RejectReadonly<L>} array - The array to modify.
- * @param {ArrayLike<L[0]>} [values] - The values to remove.
- * @param {ValueIteratee<L[0]>} [iteratee] - The iteratee invoked per element.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [iteratee] - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
@@ -50,10 +50,10 @@ declare function pullAllBy<L extends MutableList<any>>(array: RejectReadonly<L>,
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template T, U
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<U>} values - The values to remove.
- * @param {((value: T | U) => unknown) | PropertyKey | [PropertyKey, any] | Partial<T | U>} iteratee - The iteratee invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];
@@ -70,10 +70,10 @@ declare function pullAllBy<T, U>(array: T[], values: ArrayLike<U>, iteratee: Val
  * If you want to remove values without modifying the original array, use `differenceBy`.
  *
  * @template L, U
- * @param {L} array - The array to modify.
- * @param {ArrayLike<U>} values - The values to remove.
- * @param {((value: L[0] | U) => unknown) | PropertyKey | [PropertyKey, any] | Partial<L[0] | U>} iteratee - The iteratee invoked per element.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param iteratee - The iteratee invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];

package/dist/compat/array/pullAllBy.js

@@ -7,10 +7,10 @@ const require_iteratee = require("../util/iteratee.js");
 * If you want to remove values without modifying the original array, use `differenceBy`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {ArrayLike<T>} valuesToRemove - The values to remove from the array.
-* @param {keyof T} getValue - The key of the property to match against each element.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @param getValue - The key of the property to match against each element.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * // Using a iteratee function

package/dist/compat/array/pullAllBy.mjs

@@ -7,10 +7,10 @@ import { iteratee } from "../util/iteratee.mjs";
 * If you want to remove values without modifying the original array, use `differenceBy`.
 *
 * @template T
-* @param {T[]} arr - The array to modify.
-* @param {ArrayLike<T>} valuesToRemove - The values to remove from the array.
-* @param {keyof T} getValue - The key of the property to match against each element.
-* @returns {T[]} The modified array with the specified values removed.
+* @param arr - The array to modify.
+* @param valuesToRemove - The values to remove from the array.
+* @param getValue - The key of the property to match against each element.
+* @returns The modified array with the specified values removed.
 *
 * @example
 * // Using a iteratee function

package/dist/compat/array/pullAllWith.d.mts

@@ -10,10 +10,10 @@ import { RejectReadonly } from "../_internal/RejectReadonly.mjs";
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<T>} [values] - The values to remove.
- * @param {(a: T, b: T) => boolean} [comparator] - The comparator invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [comparator] - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
@@ -31,10 +31,10 @@ declare function pullAllWith<T>(array: T[], values?: ArrayLike<T>, comparator?:
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template L
- * @param {RejectReadonly<L>} array - The array to modify.
- * @param {List<L[0]>} [values] - The values to remove.
- * @param {Comparator<L[0]>} [comparator] - The comparator invoked per element.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [comparator] - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
@@ -52,10 +52,10 @@ declare function pullAllWith<L extends MutableList<any>>(array: RejectReadonly<L
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template T, U
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<U>} values - The values to remove.
- * @param {(a: T, b: U) => boolean} comparator - The comparator invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
@@ -73,10 +73,10 @@ declare function pullAllWith<T, U>(array: T[], values: ArrayLike<U>, comparator:
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template L1, L2
- * @param {RejectReadonly<L1>} array - The array to modify.
- * @param {List<L2>} values - The values to remove.
- * @param {Comparator2<L1[0], L2>} comparator - The comparator invoked per element.
- * @returns {L1} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];

package/dist/compat/array/pullAllWith.d.ts

@@ -10,10 +10,10 @@ import { RejectReadonly } from "../_internal/RejectReadonly.js";
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<T>} [values] - The values to remove.
- * @param {(a: T, b: T) => boolean} [comparator] - The comparator invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [comparator] - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
@@ -31,10 +31,10 @@ declare function pullAllWith<T>(array: T[], values?: ArrayLike<T>, comparator?:
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template L
- * @param {RejectReadonly<L>} array - The array to modify.
- * @param {List<L[0]>} [values] - The values to remove.
- * @param {Comparator<L[0]>} [comparator] - The comparator invoked per element.
- * @returns {L} Returns `array`.
+ * @param array - The array to modify.
+ * @param [values] - The values to remove.
+ * @param [comparator] - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
@@ -52,10 +52,10 @@ declare function pullAllWith<L extends MutableList<any>>(array: RejectReadonly<L
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template T, U
- * @param {T[]} array - The array to modify.
- * @param {ArrayLike<U>} values - The values to remove.
- * @param {(a: T, b: U) => boolean} comparator - The comparator invoked per element.
- * @returns {T[]} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
@@ -73,10 +73,10 @@ declare function pullAllWith<T, U>(array: T[], values: ArrayLike<U>, comparator:
  * **Note:** Unlike `_.differenceWith`, this method mutates `array`.
  *
  * @template L1, L2
- * @param {RejectReadonly<L1>} array - The array to modify.
- * @param {List<L2>} values - The values to remove.
- * @param {Comparator2<L1[0], L2>} comparator - The comparator invoked per element.
- * @returns {L1} Returns `array`.
+ * @param array - The array to modify.
+ * @param values - The values to remove.
+ * @param comparator - The comparator invoked per element.
+ * @returns Returns `array`.
  *
  * @example
  * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];

package/dist/compat/array/pullAllWith.js

@@ -6,10 +6,10 @@ const require_copyArray = require("../_internal/copyArray.js");
 * Removes and returns elements from an array using a provided comparison function to determine which elements to remove.
 *
 * @template T
-* @param {T[] | ArrayLike<T>} array - The array to modify.
-* @param {T[] | ArrayLike<T>} values - The values to remove from the array.
-* @param {(a: T, b: T) => boolean} comparator - The function to compare elements of `array` with elements of `values`. Should return `true` if the two elements are considered equal.
-* @returns {T[] | ArrayLike<T>} - The array with specified values removed.
+* @param array - The array to modify.
+* @param values - The values to remove from the array.
+* @param comparator - The function to compare elements of `array` with elements of `values`. Should return `true` if the two elements are considered equal.
+* @returns The array with specified values removed.
 *
 * @example
 * import pullAllWith from './pullAllWith';

package/dist/compat/array/pullAllWith.mjs

@@ -6,10 +6,10 @@ import copyArray from "../_internal/copyArray.mjs";
 * Removes and returns elements from an array using a provided comparison function to determine which elements to remove.
 *
 * @template T
-* @param {T[] | ArrayLike<T>} array - The array to modify.
-* @param {T[] | ArrayLike<T>} values - The values to remove from the array.
-* @param {(a: T, b: T) => boolean} comparator - The function to compare elements of `array` with elements of `values`. Should return `true` if the two elements are considered equal.
-* @returns {T[] | ArrayLike<T>} - The array with specified values removed.
+* @param array - The array to modify.
+* @param values - The values to remove from the array.
+* @param comparator - The function to compare elements of `array` with elements of `values`. Should return `true` if the two elements are considered equal.
+* @returns The array with specified values removed.
 *
 * @example
 * import pullAllWith from './pullAllWith';

package/dist/compat/array/pullAt.d.mts

@@ -10,9 +10,9 @@ import { Many } from "../_internal/Many.mjs";
  * **Note:** Unlike `_.at`, this method mutates `array`.
  *
  * @template T
- * @param {T[]} array - The array to modify.
- * @param {...Array<number | number[]>} indexes - The indexes of elements to remove, specified as individual indexes or arrays of indexes.
- * @returns {T[]} Returns the new array of removed elements.
+ * @param array - The array to modify.
+ * @param indexes - The indexes of elements to remove, specified as individual indexes or arrays of indexes.
+ * @returns Returns the new array of removed elements.
  *
  * @example
  * var array = [5, 10, 15, 20];
@@ -32,9 +32,9 @@ declare function pullAt<T>(array: T[], ...indexes: Array<Many<number>>): T[];
  * **Note:** Unlike `_.at`, this method mutates `array`.
  *
  * @template L
- * @param {L} array - The array to modify.
- * @param {...Array<number | number[]>} indexes - The indexes of elements to remove, specified as individual indexes or arrays of indexes.
- * @returns {L} Returns the new array of removed elements.
+ * @param array - The array to modify.
+ * @param indexes - The indexes of elements to remove, specified as individual indexes or arrays of indexes.
+ * @returns Returns the new array of removed elements.
  *
  * @example
  * var array = [5, 10, 15, 20];