24 lines
1.2 KiB
TypeScript
24 lines
1.2 KiB
TypeScript
/**
|
|
* Recursively assigns default values to an `object`, ensuring that certain properties do not remain `undefined`.
|
|
* It sets default values for properties that are either `undefined` or inherited from `Object.prototype`.
|
|
*
|
|
* Similar to `defaults` but recursively applies default values to nested objects.
|
|
* Source objects are applied in order from left to right, and once a property has been assigned a value,
|
|
* any subsequent values for that property will be ignored.
|
|
*
|
|
* Note: This function modifies the first argument, `object`.
|
|
*
|
|
* @template T - The type of the object being processed.
|
|
* @param {any} target - The target object that will receive default values.
|
|
* @param {any[]} sources - One or more source objects that specify default values to apply.
|
|
* @returns {any} The `object` that has been updated with default values from all sources, recursively merging nested objects.
|
|
*
|
|
* @example
|
|
* defaultsDeep({ a: { b: 2 } }, { a: { b: 3, c: 3 }, d: 4 }); // { a: { b: 2, c: 3 }, d: 4 }
|
|
* defaultsDeep({ a: { b: undefined } }, { a: { b: 1 } }); // { a: { b: 1 } }
|
|
* defaultsDeep({ a: null }, { a: { b: 1 } }); // { a: null }
|
|
*/
|
|
declare function defaultsDeep(target: any, ...sources: any[]): any;
|
|
|
|
export { defaultsDeep };
|