updateWith

INFO

この関数は互換性のためにes-toolkit/compatでのみ利用可能です。代替のネイティブJavaScript APIが存在するか、まだ完全に最適化されていません。

es-toolkit/compatからインポートする場合、この関数はlodashと全く同じように動作し、同じ機能を提供します。

オブジェクトの指定されたパスにある値をupdater関数が返す値で更新します。パスの一部が存在しない場合、customizer関数を使用して新しいオブジェクトをどのように作成するかを指定できます。

インターフェース

function updateWith<T extends object | null | undefined>(
  obj: T,
  path: PropertyKey | readonly PropertyKey[],
  updater: (value: unknown) => unknown,
  customizer: (value: unknown) => unknown
): T;

パラメータ

• obj (T): 修正するオブジェクトです。
• path (PropertyKey | readonly PropertyKey[]): 更新するプロパティのパスです。
• updater ((value: unknown) => unknown): 更新された値を生成する関数です。
• customizer ((value: unknown) => unknown): 更新プロセスをカスタマイズする関数です。

戻り値

(T): 修正されたオブジェクトです。

例

import { updateWith } from 'es-toolkit/compat';

const object = { a: [{ b: { c: 3 } }] };

// カスタマイザー関数を使用してカスタムパス構造を作成する
updateWith(object, '[0].a.b.c', n => (n as number) + 1, customizer);
// => { '0': { a: { b: { c: 4 } } }, a: [{ b: { c: 3 } }] }

function customizer(value: unknown) {
  if (value == null) {
    return {};
  }
  return value;
}