Options
All
  • Public
  • Public/Protected
  • All
Menu

Module update

Index

Functions Object

Object Functions

  • update<U>(object: any, path: string | string[], updater?: U): ReturnType<U>
  • This method is like set except that it accepts updater to produce the value to set. Use updateWith to customize path creation. The updater is invoked with one argument: (value).

    Note: This method mutates object.

    since

    5.3.0

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

    update(object, 'a[0].b.c', n => n * n)
    console.log(object.a[0].b.c)
    // => 9

    update(object, 'x[0].y.z', n => n ? n + 1 : 0)
    console.log(object.x[0].y.z)
    // => 0

    Type Parameters

    • U extends ((...args: any[]) => any)

    Parameters

    • object: any

      The object to modify.

    • path: string | string[]

      The path of the property to set.

    • Optional updater: U

      The function to produce the updated value.

    Returns ReturnType<U>

    Returns object.