For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /reference/fp/dropWhile.md.

dropWhile (Functional Programming) es-toolkit

Creates a function that drops leading values while a predicate passes. Use it with pipe.

const result = pipe(array, dropWhile(predicate));
Info

Prefer the original es-toolkit dropWhile in ordinary code. Use this fp variant when composing transformations with pipe.

Usage

dropWhile walks the piped array from the beginning and removes values while predicate returns true. It is lazy-capable inside pipe.

import { dropWhile, pipe } from 'es-toolkit/fp';

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

Parameters

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

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

Returns

A function that maps a readonly T[] to the values left after dropping from the beginning.

(array: readonly T[]) => T[]
Source: es-toolkit

Re-exported verbatim from es-toolkit. Implementation, edge cases, and performance behavior are owned upstream. This page mirrors the documentation at the pinned version; the linked source is authoritative.