Function head

Alias

head<T>(arr): T
Returns the first element of an array.

This function takes an array and returns the first element of the array. If the array is empty, the function returns undefined.
Type Parameters
- T
  The type of elements in the array.
Parameters
- arr: readonly [T, T]
  A non-empty array from which to get the first element.
Returns T
The first element of the array.
Example
```
const arr = [1, 2, 3];
const firstElement = head(arr);
// firstElement will be 1
```
- Defined in src/array.ts:108
head<T>(arr): T | undefined
Returns the first element of an array or undefined if the array is empty.

This function takes an array and returns the first element of the array. If the array is empty, the function returns undefined.
Type Parameters
- T
  The type of elements in the array.
Parameters
- arr: readonly T[]
  The array from which to get the first element.
Returns T | undefined
The first element of the array, or undefined if the array is empty.
Example
```
const emptyArr: number[] = [];
const noElement = head(emptyArr);
// noElement will be undefined
```
- Defined in src/array.ts:108