mirror of
https://github.com/toss/es-toolkit.git
synced 2024-11-28 03:34:26 +03:00
30 lines
741 B
Markdown
30 lines
741 B
Markdown
|
# drop
|
||
|
|
|
||
|
|
Removes a specified number of elements from the beginning of an array and returns the rest.
|
||
|
|
|
||
|
|
This function takes an array and a number, and returns a new array with the specified number
|
||
|
|
of elements removed from the start.
|
||
|
|
|
||
|
|
## Signature
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
function drop<T>(arr: T[], itemsCount: number): T[];
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
- `arr` (`T[]`): The array from which to drop elements.
|
||
|
|
- `itemsCount` (`number`): The number of elements to drop from the beginning of the array.
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
(`T[]`) A new array with the specified number of elements removed from the start.
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
const array = [1, 2, 3, 4, 5];
|
||
|
|
const result = drop(array, 2);
|
||
|
|
// result will be [3, 4, 5] since the first two elements are dropped.
|
||
|
|
```
|