assign

object

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

Installation

Import

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

Source Code

Implementation

/**
 * Assigns own enumerable string keyed properties of source objects to the destination object.
 *
 * @param object - The destination object.
 * @param sources - The source objects.
 * @returns Returns object.
 *
 * @example
 * ```ts
 * function Foo() {
 *   this.a = 1;
 * }
 * function Bar() {
 *   this.c = 3;
 * }
 * Foo.prototype.b = 2;
 * Bar.prototype.d = 4;
 * assign({ 'a': 0 }, new Foo(), new Bar()); // { 'a': 1, 'c': 3 }
 * ```
 */
export function assign<T extends Record<string, unknown>>(
  object: T,
  ...sources: readonly Record<string, unknown>[]
): T {
  return Object.assign(object, ...sources);
}

Example

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

function Foo() {
this.a = 1;
}
function Bar() {
this.c = 3;
}
Foo.prototype.b = 2;
Bar.prototype.d = 4;
assign({ 'a': 0 }, new Foo(), new Bar()); // { 'a': 1, 'c': 3 }

Related Functions

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.

defaults

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