defaults

object

Assigns own enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to undefined.

Try in Playground

Installation

Import

import { defaults } from '@tulx/utils';

Source Code

Implementation

/**
 * Assigns own enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to undefined.
 *
 * @param object - The destination object.
 * @param sources - The source objects.
 * @returns Returns object.
 *
 * @example
 * ```ts
 * defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); // { 'a': 1, 'b': 2 }
 * ```
 */
export function defaults<T extends Record<string, unknown>>(
  object: T,
  ...sources: readonly Record<string, unknown>[]
): T {
  const result = object as Record<string, unknown>;
  for (const source of sources) {
    for (const key in source) {
      if (
        Object.prototype.hasOwnProperty.call(source, key) &&
        result[key] === undefined
      ) {
        result[key] = source[key];
      }
    }
  }
  return object;
}

Example

import { defaults } from '@tulx/utils';

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

Related Functions

assign

Assigns own enumerable string keyed properties of source objects to the destination object.

assignIn

This method is like assign except that it iterates over own and inherited source properties.

assignInWith

This method is like assignIn except that it accepts customizer which is invoked to produce the assigned values.

assignWith

This method is like assign except that it accepts customizer which is invoked to produce the assigned values.

Creates an array of values corresponding to paths of object.

create

Creates an object that inherits from the prototype object.