es-toolkit/dist/compat/array/take.mjs

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

import { take as take$1 } from "../../array/take.mjs";
import { toArray } from "../_internal/toArray.mjs";
import { isArrayLike } from "../predicate/isArrayLike.mjs";
import { toInteger } from "../util/toInteger.mjs";
//#region src/compat/array/take.ts
/**
* Returns a new array containing the first `count` elements from the input array `arr`.
* If `count` is greater than the length of `arr`, the entire array is returned.
*
* @template T - Type of elements in the input array.
*
* @param arr - The array to take elements from.
* @param [count=1] - The number of elements to take.
* @param [guard] - Enables use as an iteratee for methods like `_.map`.
* @returns A new array containing the first `count` elements from `arr`.
*
* @example
* // Returns [1, 2, 3]
* take([1, 2, 3, 4, 5], 3);
*
* @example
* // Returns ['a', 'b']
* take(['a', 'b', 'c'], 2);
*
* @example
* // Returns [1, 2, 3]
* take([1, 2, 3], 5);
*/
function take(arr, count = 1, guard) {
	count = guard || count === void 0 ? 1 : toInteger(count);
	if (count < 1 || !isArrayLike(arr)) return [];
	return take$1(toArray(arr), count);
}
//#endregion
export { take };