Function defaults

  • defaults(object: any, ...sources: any[]): any

  • Assigns own and inherited enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to undefined. Source objects are applied from left to right. Once a property is set, additional values of the same property are ignored.

    Note: This method mutates object.

    Parameters

    • object: any

      The destination object.

    • ...sources: any[]

      The source objects.

    Returns any

    Returns object.

    Since

    5.7.0

    See

    [[defaultsDeep]]

    Example

    defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 })
    // => { 'a': 1, 'b': 2 }

Settings

Member Visibility