> For AI agents: the complete documentation index is available at https://massaman.dev/llms.txt, the full documentation bundle is available at https://massaman.dev/llms-full.txt.

# takeWhile (Functional Programming) es-toolkit

Creates a function that takes leading values while a predicate passes. Use it with [`pipe`](https://massaman.dev/reference/fp/pipe.md).

```typescript
const result = pipe(array, takeWhile(predicate));
```

::: info

Prefer the original es-toolkit [`takeWhile`](https://massaman.dev/reference/array/takeWhile.md) in ordinary code. Use this `fp` variant when composing transformations with [`pipe`](https://massaman.dev/reference/fp/pipe.md).

:::

## Usage

`takeWhile` walks the piped array from the beginning and keeps values while `predicate` returns `true`. It is lazy-capable and can stop earlier lazy operations inside [`pipe`](https://massaman.dev/reference/fp/pipe.md).

```typescript
import { pipe, takeWhile } from 'es-toolkit/fp';

pipe(
  [1, 2, 3, 1],
  takeWhile(value => value < 3)
); // => [1, 2]
```

#### Parameters


predicate(element: T, index: number) => booleanrequired

The function that decides whether a leading value should be kept.

#### Returns

A function that maps a `readonly T[]` to the leading values that pass.

```typescript
(array: readonly T[]) => T[]
```


Source: es-toolkit

Re-exported verbatim from [`es-toolkit`](https://es-toolkit.dev/fp/reference/takeWhile.html). Implementation, edge cases, and performance behavior are owned upstream. This page mirrors the documentation at the pinned version; the linked source is authoritative.
