first

INFO

出于兼容性原因，此函数仅在 es-toolkit/compat 中提供。它可能具有替代的原生 JavaScript API，或者尚未完全优化。

从 es-toolkit/compat 导入时，它的行为与 lodash 完全一致，并提供相同的功能，详情请见 这里。

返回数组的第一个元素，如果数组为空，则返回undefined。

此函数接受一个数组并返回数组的第一个元素。 如果数组为空，函数将返回undefined。

签名

function first<T>(arr: ArrayLike<T> | undefined | null): T | undefined;

参数

• arr (ArrayLike<T> | undefined | null): 获取第一个元素的数组。

返回值

(T | undefined): 数组的第一个元素，如果数组为空，则为undefined。

示例

const arr1 = [1, 2, 3];
const firstElement1 = first(arr1);
// firstElement1 将是 1

const arr2: string[] = [];
const firstElement2 = first(arr2);
// firstElement2 将是 undefined

const arr3 = ['a', 'b', 'c'];
const firstElement3 = first(arr3);
// firstElement3 将是 'a'

const arr4 = [true, false, true];
const firstElement4 = first(arr4);
// firstElement4 将是 true

const arr5: [number, string, boolean] = [1, 'a', true];
const firstElement5 = first(arr5);
// firstElement5 将是 1