head()

head<T>(array): T | undefined

Gets the first element of array.

Alias for first.

DEPRECATED

Use array[0] or array.at(0) directly instead.

Reason:
Alias of first

---

Type Parameters

T: T

The type of elements in the array.

---

Parameters

array: T[]

The array to query.

---

Returns: T | undefined

The first element of the array, or undefined if empty.

---

See Also

• Array.at() - MDN
• Browser support - Can I Use

---

Since

2.0.0

---

Also known as

at(arr, 0) (Antfu) · first (Remeda, Radashi) · head (Lodash, es-toolkit, Ramda, Effect) · ❌ (Modern Dash)

---

Example

const numbers = [1, 2, 3, 4, 5];

// ❌ Deprecated approach
const firstElement = head(numbers);
console.log(firstElement); // 1

// ✅ Recommended approach
const firstNative = numbers[0];
console.log(firstNative); // 1

// ✅ Modern approach with ES2022
const firstModern = numbers.at(0);
console.log(firstModern); // 1

---

How it works?

Gets the first element of an array. Deprecated: Use array[0] or array.at(0) directly.

Empty Array

Native Equivalent

// ❌ head(arr)
// ✅ arr[0]
// ✅ arr.at(0)

---

Use Cases

Get first element 📌

Get the first element of an array.

#head#first#element#array

const items = [1, 2, 3, 4];
items[0];
// => 1

Get element at position

Access element at a specific index.

#nth#index#position#element

const items = ["a", "b", "c", "d"];
items[2];
// => "c"

Get element from end

Access elements from the end using negative index.

#negative#index#last#end

const items = [1, 2, 3, 4, 5];
items.at(-2);
// => 4