differenceBy (関数型プログラミング)

マッピングされたキーを基準に値を除外する関数を作成します。関数型プログラミングの pipe と一緒に使用します。

const result = pipe(array, differenceBy(secondArray, mapper));

INFO

パイプラインとして組み合わせない通常のコードでは、元の es-toolkit の differenceBy を使うのがおすすめです。pipe で変換をつなげるときは、この fp 版を使用してください。

使用法

differenceBy は mapper が返す値を比較します。パイプされた配列の値は、マッピングされたキーが secondArray に存在しない場合だけ残ります。

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

pipe(
  [{ id: 1 }, { id: 2 }],
  differenceBy([2], value => (typeof value === 'number' ? value : value.id))
); // => [{ id: 1 }]

パラメータ

• secondArray (readonly U[]): マッピングされたキーを除外基準として使う値の配列です。
• mapper ((item: T | U) => unknown): 比較キーを返す関数です。

戻り値

((array: readonly T[]) => T[]): readonly T[] を secondArray にキーが存在しない値の配列に変換する関数です。