@stdlib/object/assign/docs/types/index.d.ts

Object.

/*
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Copies own enumerable properties from one or more source objects to a target object.
*
* ## Notes
*
* -   If a property key is present in multiple sources, the property from the last source that defines the key prevails.
* -   The target object is mutated.
*
* @param target - target object
* @param source - source object
* @throws first argument must not be null or undefined
* @returns target object
*
* @example
* var obj1 = {
*     'a': 'beep'
* };
* var obj2 = {
*     'b': 'boop'
* };
*
* var out = assign( obj1, obj2 );
* // returns { 'a': 'beep', 'b': 'boop' }
*/
declare function assign<T extends object, U>( target: T, source: U ): T & U;

/**
* Copies own enumerable properties from one or more source objects to a target object.
*
* ## Notes
*
* -   If a property key is present in multiple sources, the property from the last source that defines the key prevails.
* -   The target object is mutated.
*
* @param target - target object
* @param source1 - first source object
* @param source2 - second source object
* @throws first argument must not be null or undefined
* @returns target object
*/
declare function assign<T extends object, U, V>( target: T, source1: U, source2: V ): T & U & V;

/**
* Copies own enumerable properties from one or more source objects to a target object.
*
* ## Notes
*
* -   If a property key is present in multiple sources, the property from the last source that defines the key prevails.
* -   The target object is mutated.
*
* @param target - target object
* @param source1 - first source object
* @param source2 - second source object
* @param source3 - third source object
* @throws first argument must not be null or undefined
* @returns target object
*/
declare function assign<T extends object, U, V, W>( target: T, source1: U, source2: V, source3: W ): T & U & V & W;

/**
* Copies own enumerable properties from one or more source objects to a target object.
*
* ## Notes
*
* -   If a property key is present in multiple sources, the property from the last source that defines the key prevails.
* -   The target object is mutated.
*
* @param target - target object
* @param source - source object(s)
* @throws first argument must not be null or undefined
* @returns target object
*
* @example
* var obj1 = {
*     'a': 'beep'
* };
* var obj2 = {
*     'b': 'boop'
* };
*
* var out = assign( obj1, obj2 );
* // returns { 'a': 'beep', 'b': 'boop' }
*/
declare function assign( target: object, ...source: Array<any> ): object;


// EXPORTS //

export = assign;