mirror of
https://github.com/nunocoracao/blowfish.git
synced 2025-02-02 19:42:34 -06:00
31 lines
1.6 KiB
TypeScript
31 lines
1.6 KiB
TypeScript
export default assignWithDepth;
|
|
/**
|
|
* @function assignWithDepth Extends the functionality of {@link ObjectConstructor.assign} with the
|
|
* ability to merge arbitrary-depth objects For each key in src with path `k` (recursively)
|
|
* performs an Object.assign(dst[`k`], src[`k`]) with a slight change from the typical handling of
|
|
* undefined for dst[`k`]: instead of raising an error, dst[`k`] is auto-initialized to {} and
|
|
* effectively merged with src[`k`]<p> Additionally, dissimilar types will not clobber unless the
|
|
* config.clobber parameter === true. Example:
|
|
*
|
|
* ```js
|
|
* let config_0 = { foo: { bar: 'bar' }, bar: 'foo' };
|
|
* let config_1 = { foo: 'foo', bar: 'bar' };
|
|
* let result = assignWithDepth(config_0, config_1);
|
|
* console.log(result);
|
|
* //-> result: { foo: { bar: 'bar' }, bar: 'bar' }
|
|
* ```
|
|
*
|
|
* Traditional Object.assign would have clobbered foo in config_0 with foo in config_1. If src is a
|
|
* destructured array of objects and dst is not an array, assignWithDepth will apply each element
|
|
* of src to dst in order.
|
|
* @param {any} dst - The destination of the merge
|
|
* @param {any} src - The source object(s) to merge into destination
|
|
* @param {{ depth: number; clobber: boolean }} [config={ depth: 2, clobber: false }] - Depth: depth
|
|
* to traverse within src and dst for merging - clobber: should dissimilar types clobber (default:
|
|
* { depth: 2, clobber: false }). Default is `{ depth: 2, clobber: false }`
|
|
* @returns {any}
|
|
*/
|
|
declare function assignWithDepth(dst: any, src: any, config?: {
|
|
depth: number;
|
|
clobber: boolean;
|
|
} | undefined): any;
|