VDL Plugin SDK

take

Import from @varavel/vdl-plugin-sdk/utils/arrays.

function take<T>(arr, count): T[];

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.

Type Parameters

Type ParameterDescription
TType of elements in the input array.

Parameters

ParameterTypeDescription
arrreadonly T[]The array to take elements from.
countnumberThe number of elements to take.

Returns

T[]

A new array containing the first count elements from arr.

Examples

// Returns [1, 2, 3]
take([1, 2, 3, 4, 5], 3);
// Returns ['a', 'b']
take(['a', 'b', 'c'], 2);
// Returns [1, 2, 3]
take([1, 2, 3], 5);