LendAndRegret/node_modules/es-toolkit/dist/compat/array/take.d.mts
2026-05-02 17:27:43 +08:00

28 lines
583 B
TypeScript

/**
* Creates a slice of array with n elements taken from the beginning.
*
* @template T
* @param {ArrayLike<T> | null | undefined} array - The array to query.
* @param {number} [n=1] - The number of elements to take.
* @returns {T[]} Returns the slice of array.
*
* @example
* take([1, 2, 3]);
* // => [1]
*
* @example
* take([1, 2, 3], 2);
* // => [1, 2]
*
* @example
* take([1, 2, 3], 5);
* // => [1, 2, 3]
*
* @example
* take([1, 2, 3], 0);
* // => []
*/
declare function take<T>(array: ArrayLike<T> | null | undefined, n?: number): T[];
export { take };