52 lines
2.6 KiB
TypeScript
52 lines
2.6 KiB
TypeScript
import { PropertyPath } from '../_internal/PropertyPath.mjs';
|
|
|
|
/**
|
|
* Sets the value at the specified path of the given object using a customizer function.
|
|
* If any part of the path does not exist, it will be created based on the customizer's result.
|
|
*
|
|
* The customizer is invoked to produce the objects of the path. If the customizer returns
|
|
* a value, that value is used for the current path segment. If the customizer returns
|
|
* `undefined`, the method will create an appropriate object based on the path - an array
|
|
* if the next path segment is a valid array index, or an object otherwise.
|
|
*
|
|
* @template T - The type of the object.
|
|
* @param {T} object - The object to modify.
|
|
* @param {PropertyPath} path - The path of the property to set.
|
|
* @param {any} value - The value to set.
|
|
* @param {(nsValue: any, key: string, nsObject: T) => any} [customizer] - The function to customize assigned values.
|
|
* @returns {T} - The modified object.
|
|
*
|
|
* @example
|
|
* // Set a value with a customizer that creates arrays for numeric path segments
|
|
* const object = {};
|
|
* setWith(object, '[0][1]', 'a', (value) => Array.isArray(value) ? value : []);
|
|
* // => { '0': [, 'a'] }
|
|
*/
|
|
declare function setWith<T extends object>(object: T, path: PropertyPath, value: any, customizer?: (nsValue: any, key: string, nsObject: T) => any): T;
|
|
/**
|
|
* Sets the value at the specified path of the given object using a customizer function.
|
|
* If any part of the path does not exist, it will be created based on the customizer's result.
|
|
*
|
|
* The customizer is invoked to produce the objects of the path. If the customizer returns
|
|
* a value, that value is used for the current path segment. If the customizer returns
|
|
* `undefined`, the method will create an appropriate object based on the path - an array
|
|
* if the next path segment is a valid array index, or an object otherwise.
|
|
*
|
|
* @template T - The type of the object.
|
|
* @template R - The type of the return value.
|
|
* @param {T} object - The object to modify.
|
|
* @param {PropertyPath} path - The path of the property to set.
|
|
* @param {any} value - The value to set.
|
|
* @param {(nsValue: any, key: string, nsObject: T) => any} [customizer] - The function to customize assigned values.
|
|
* @returns {R} - The modified object.
|
|
*
|
|
* @example
|
|
* // Set a value with a customizer that creates arrays for numeric path segments
|
|
* const object = {};
|
|
* setWith(object, '[0][1]', 'a', (value) => Array.isArray(value) ? value : []);
|
|
* // => { '0': [, 'a'] }
|
|
*/
|
|
declare function setWith<T extends object, R>(object: T, path: PropertyPath, value: any, customizer?: (nsValue: any, key: string, nsObject: T) => any): R;
|
|
|
|
export { setWith };
|