updateWith

INFO

This function is only available in es-toolkit/compat for compatibility reasons. It either has alternative native JavaScript APIs or isn't fully optimized yet.

When imported from es-toolkit/compat, it behaves exactly like lodash and provides the same functionalities.

Updates the value at the specified path of an object with the value returned by the updater function. If parts of the path don’t exist, you can use the customizer function to define how new objects should be created.

Signature

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

Parameters

• obj (T): The object to modify.
• path (PropertyKey | readonly PropertyKey[]): The path of the property to update.
• updater ((value: unknown) => unknown): The function to produce the updated value.
• customizer ((value: unknown) => unknown): The function to customize the update process.

Returns

(T): The modified object.

Examples

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

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

// Use a customizer function to create custom path structures
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;
}