Function default

  • default<T>(
        object: T,
        path: string | string[],
        value?: any,
        customizer?: (...any: any[]) => any,
    ): T

  • This method is like set except that it accepts customizer which is invoked to produce the objects of path. If customizer returns undefined path creation is handled by the method instead. The customizer is invoked with three arguments: (nsValue, key, nsObject).

    Note: This method mutates object.

    Type Parameters

    • T

    Parameters

    • object: T

      The object to modify.

    • path: string | string[]
    • Optionalvalue: any

      The value to set.

    • Optionalcustomizer: (...any: any[]) => any

      The function to customize assigned values.

    Returns T

    Returns object.

    Since

    5.3.0

    Example

    const object = {}

    setWith(object, '[0][1]', 'a', Object)
    // => { '0': { '1': 'a' } }

Settings

Member Visibility