set
object
Sets the value at path of object.
Installation
Import
import { set } from '@tulx/utils';Source Code
Implementation
/**
* Sets the value at path of object.
*
* @param object - The object to modify.
* @param path - The path of the property to set.
* @param value - The value to set.
* @returns Returns object.
*
* @example
* ```ts
* const object = { 'a': [{ 'b': { 'c': 3 } }] };
* set(object, 'a[0].b.c', 4);
* console.log(object.a[0].b.c); // 4
* ```
*/
export function set<T extends Record<string, unknown>>(
object: T,
path: string | readonly (string | number)[],
value: unknown
): T {
const pathArray = Array.isArray(path)
? path.map(String)
: parsePath(String(path));
let current: Record<string, unknown> = object;
for (let i = 0; i < pathArray.length - 1; i++) {
const key = pathArray[i];
if (
!(key in current) ||
typeof current[key] !== 'object' ||
current[key] === null
) {
current[key] = {};
}
current = current[key] as Record<string, unknown>;
}
current[pathArray[pathArray.length - 1]] = value;
return object;
}
function parsePath(path: string): string[] {
const keys: string[] = [];
let current = '';
let inBrackets = false;
for (let i = 0; i < path.length; i++) {
const char = path[i];
if (char === '[') {
if (current) {
keys.push(current);
current = '';
}
inBrackets = true;
} else if (char === ']') {
if (current) {
keys.push(current);
current = '';
}
inBrackets = false;
} else if (char === '.' && !inBrackets) {
if (current) {
keys.push(current);
current = '';
}
} else {
current += char;
}
}
if (current) {
keys.push(current);
}
return keys;
}
Example
import { set } from '@tulx/utils';
const object = { 'a': [{ 'b': { 'c': 3 } }] };
set(object, 'a[0].b.c', 4);
console.log(object.a[0].b.c); // 4Related Functions
assign
Assigns own enumerable string keyed properties of source objects to the destination object.
assignIn
This method is like assign except that it iterates over own and inherited source properties.
assignInWith
This method is like assignIn except that it accepts customizer which is invoked to produce the assigned values.
assignWith
This method is like assign except that it accepts customizer which is invoked to produce the assigned values.
at
Creates an array of values corresponding to paths of object.
create
Creates an object that inherits from the prototype object.