20 lines
656 B
TypeScript
20 lines
656 B
TypeScript
|
//#region src/array/pull.d.ts
|
||
|
|
/**
|
||
|
|
* Removes all specified values from an array.
|
||
|
|
*
|
||
|
|
* This function changes `arr` in place.
|
||
|
|
* If you want to remove values without modifying the original array, use `difference`.
|
||
|
|
*
|
||
|
|
* @template T, U
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* const numbers = [1, 2, 3, 4, 5, 2, 4];
|
||
|
|
* pull(numbers, [2, 4]);
|
||
|
|
* console.log(numbers); // [1, 3, 5]
|
||
|
|
*/
|
||
|
|
declare function pull<T>(arr: T[], valuesToRemove: readonly unknown[]): T[];
|
||
|
|
//#endregion
|
||
|
|
export { pull };
|