Back to Es Toolkit

difference (Functional Programming)

docs/fp/reference/difference.md

1.49.0883 B
Original Source

difference (Functional Programming)

Creates a function that excludes values found in another array. Use it with pipe.

typescript
const result = pipe(array, difference(secondArray));

::: info

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

:::

Usage

difference keeps values from the piped array that are not present in secondArray. It preserves the order of the piped array.

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

pipe([1, 2, 3, 4], difference([2, 4])); // => [1, 3]

Parameters

  • secondArray (readonly T[]): The array containing values to exclude.

Returns

((array: readonly T[]) => T[]): A function that maps a readonly T[] to values not found in secondArray.