es-toolkit
Version:
A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.
67 lines (66 loc) • 1.92 kB
JavaScript
import { isUnsafeProperty } from "../../_internal/isUnsafeProperty.mjs";
import { isDeepKey } from "../_internal/isDeepKey.mjs";
import { toKey } from "../_internal/toKey.mjs";
import { toPath } from "../util/toPath.mjs";
import { get } from "./get.mjs";
//#region src/compat/object/unset.ts
/**
* Removes the property at the given path of the object.
*
* @param obj - The object to modify.
* @param path - The path of the property to unset.
* @returns Returns true if the property is deleted, else false.
*
* @example
* const obj = { a: { b: { c: 42 } } };
* unset(obj, 'a.b.c'); // true
* console.log(obj); // { a: { b: {} } }
*
* @example
* const obj = { a: { b: { c: 42 } } };
* unset(obj, ['a', 'b', 'c']); // true
* console.log(obj); // { a: { b: {} } }
*/
function unset(obj, path) {
if (obj == null) return true;
switch (typeof path) {
case "symbol":
case "number":
case "object":
if (Array.isArray(path)) return unsetWithPath(obj, path);
if (typeof path === "number") path = toKey(path);
else if (typeof path === "object") if (Object.is(path?.valueOf(), -0)) path = "-0";
else path = String(path);
if (isUnsafeProperty(path)) return false;
if (obj?.[path] === void 0) return true;
try {
delete obj[path];
return true;
} catch {
return false;
}
case "string":
if (obj?.[path] === void 0 && isDeepKey(path) && !Object.hasOwn(obj, path)) return unsetWithPath(obj, toPath(path));
if (isUnsafeProperty(path)) return false;
try {
delete obj[path];
return true;
} catch {
return false;
}
}
}
function unsetWithPath(obj, path) {
const parent = path.length === 1 ? obj : get(obj, path.slice(0, -1));
const lastKey = path[path.length - 1];
if (parent?.[lastKey] === void 0) return true;
if (isUnsafeProperty(lastKey)) return false;
try {
delete parent[lastKey];
return true;
} catch {
return false;
}
}
//#endregion
export { unset };