39 lines
1.7 KiB
TypeScript
39 lines
1.7 KiB
TypeScript
import { PropertyPath } from '../_internal/PropertyPath.mjs';
|
|
|
|
/**
|
|
* Creates a deeply nested object given arrays of paths and values.
|
|
*
|
|
* This function takes two arrays: one containing arrays of property paths, and the other containing corresponding values.
|
|
* It returns a new object where paths from the first array are used as key paths to set values, with corresponding elements from the second array as values.
|
|
* Paths can be dot-separated strings or arrays of property names.
|
|
*
|
|
* If the `keys` array is longer than the `values` array, the remaining keys will have `undefined` as their values.
|
|
*
|
|
* @template P - The type of property paths.
|
|
* @template V - The type of values corresponding to the property paths.
|
|
* @param {ArrayLike<P | P[]>} keys - An array of property paths, each path can be a dot-separated string or an array of property names.
|
|
* @param {ArrayLike<V>} values - An array of values corresponding to the property paths.
|
|
* @returns {Record<P, V>} A new object composed of the given property paths and values.
|
|
*
|
|
* @example
|
|
* const paths = ['a.b.c', 'd.e.f'];
|
|
* const values = [1, 2];
|
|
* const result = zipObjectDeep(paths, values);
|
|
* // result will be { a: { b: { c: 1 } }, d: { e: { f: 2 } } }
|
|
*
|
|
* @example
|
|
* const paths = [['a', 'b', 'c'], ['d', 'e', 'f']];
|
|
* const values = [1, 2];
|
|
* const result = zipObjectDeep(paths, values);
|
|
* // result will be { a: { b: { c: 1 } }, d: { e: { f: 2 } } }
|
|
*
|
|
* @example
|
|
* const paths = ['a.b[0].c', 'a.b[1].d'];
|
|
* const values = [1, 2];
|
|
* const result = zipObjectDeep(paths, values);
|
|
* // result will be { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }
|
|
*/
|
|
declare function zipObjectDeep(keys?: ArrayLike<PropertyPath>, values?: ArrayLike<any>): object;
|
|
|
|
export { zipObjectDeep };
|