head (Iterator)

이터레이터의 첫 번째 요소를 반환해요. 비어 있으면 undefined를 반환해요.

const first = head(source);

사용법

head(source)

지연 평가 파이프라인이 내보내는 첫 번째 요소만 필요할 때 head를 사용하세요. 요소를 하나만 꺼내고 멈추기 때문에, 무한 이터레이터에도 안전하게 쓸 수 있어요.

head는 이터레이터를 엿보는 것이 아니라 소비해요. 첫 번째 요소를 읽고 나면 네이티브 Iterator.prototype.find와 마찬가지로 소스가 return 메서드를 통해 닫혀서, 더 이상 순회할 수 없어요.

import { head } from 'es-toolkit/iterator';

// 첫 번째 요소를 읽어요.
head([1, 2, 3].values());
// 반환 값: 1

// 빈 이터레이터는 undefined를 반환해요.
head([].values());
// 반환 값: undefined

// 지연 평가 체인의 앞쪽 요소들만 계산돼요.
head([1, 2, 3, 4].values().filter(x => x % 2 === 0));
// 반환 값: 2

파라미터

• source (Iterator<T>): 첫 번째 요소를 읽을 이터레이터예요.

반환 값

(T | undefined): 첫 번째 요소예요. 이터레이터가 아무것도 내보내지 않으면 undefined예요.