es-toolkit/dist/fp/array/drop.mjs

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

import { drop as drop$1 } from "../../array/drop.mjs";
import { combineEagerAndLazyFunctions, createLazyFunction } from "../_internal/lazy.mjs";
//#region src/fp/array/drop.ts
/**
* Creates a function that removes a number of values from the start of an array.
*
* Negative counts are treated as 0, matching the main {@link drop}
* implementation. The returned function is lazy-capable inside {@link pipe}.
*
* @template T - The type of elements in the array.
* @param count - The number of values to skip from the start.
* @returns A function that maps the piped array to the remaining suffix.
*
* @example
* import { drop, pipe } from 'es-toolkit/fp';
*
* pipe([1, 2, 3, 4], drop(2));
* // => [3, 4]
*/
function drop(count) {
	const normalizedCount = Number.isNaN(count) ? 0 : Math.trunc(Math.max(count, 0));
	function dropEager(array) {
		return drop$1(array, count);
	}
	return combineEagerAndLazyFunctions(dropEager, createLazyFunction((value, index, emit) => {
		if (index >= normalizedCount) emit(value);
	}));
}
//#endregion
export { drop };