27 lines
1.2 KiB
JavaScript
27 lines
1.2 KiB
JavaScript
|
//#region src/array/dropWhile.ts
|
||
|
|
/**
|
||
|
|
* Removes elements from the beginning of an array until the predicate returns false.
|
||
|
|
*
|
||
|
|
* This function iterates over an array and drops elements from the start until the provided
|
||
|
|
* predicate function returns false. It then returns a new array with the remaining elements.
|
||
|
|
*
|
||
|
|
* @template T - The type of elements in the array.
|
||
|
|
* @param {T[]} arr - The array from which to drop elements.
|
||
|
|
* @param {(item: T, index: number, arr: T[]) => boolean} canContinueDropping - A predicate function that determines
|
||
|
|
* whether to continue dropping elements. The function is called with each element, and dropping
|
||
|
|
* continues as long as it returns true.
|
||
|
|
* @returns {T[]} A new array with the elements remaining after the predicate returns false.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* const array = [1, 2, 3, 4, 5];
|
||
|
|
* const result = dropWhile(array, x => x < 3);
|
||
|
|
* // result will be [3, 4, 5] since elements less than 3 are dropped.
|
||
|
|
*/
|
||
|
|
function dropWhile(arr, canContinueDropping) {
|
||
|
|
const dropEndIndex = arr.findIndex((item, index, arr) => !canContinueDropping(item, index, arr));
|
||
|
|
if (dropEndIndex === -1) return [];
|
||
|
|
return arr.slice(dropEndIndex);
|
||
|
|
}
|
||
|
|
//#endregion
|
||
|
|
export { dropWhile };
|