es-toolkit/docs/reference/array/dropRightWhile.md

30 lines
1014 B
Markdown
Raw Normal View History

2024-04-25 14:56:13 +03:00
# dropRightWhile
Removes elements from the end of an array until the predicate returns false.
This function iterates over an array and drops elements from the start until the provided
2024-04-25 14:56:13 +03:00
predicate function returns false. It then returns a new array with the remaining elements.
## Signature
```typescript
function dropRightWhile<T>(arr: T[], canContinueDropping: (item: T) => boolean): T[];
2024-04-25 14:56:13 +03:00
```
### Parameters
2024-04-25 14:56:13 +03:00
- `arr` (`T[]`): The array from which to drop elements.
- `canContinueDropping` (`(item: T) => boolean`): A predicate function that determines whether to continue dropping elements. The function is called with each element from the end, 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.
## Examples
```typescript
const array = [1, 2, 3, 4, 5];
const result = dropRightWhile(array, x => x > 3);
// result will be [1, 2, 3] since elements greater than 3 are dropped from the end.
```