es-toolkit 1.18.0-dev.596 → 1.18.0-dev.600

package/dist/compat/array/indexOf.d.mts

@@ -16,6 +16,6 @@
  * indexOf(array, 3); // => 2
  * indexOf(array, NaN); // => 3
  */
-declare function indexOf<T>(array: T[] | null | undefined, searchElement: T, fromIndex?: number): number;
+declare function indexOf<T>(array: readonly T[] | null | undefined, searchElement: T, fromIndex?: number): number;
 
 export { indexOf };

package/dist/compat/array/indexOf.d.ts

@@ -16,6 +16,6 @@
  * indexOf(array, 3); // => 2
  * indexOf(array, NaN); // => 3
  */
-declare function indexOf<T>(array: T[] | null | undefined, searchElement: T, fromIndex?: number): number;
+declare function indexOf<T>(array: readonly T[] | null | undefined, searchElement: T, fromIndex?: number): number;
 
 export { indexOf };

package/dist/compat/array/orderBy.mjs

@@ -1,6 +1,6 @@
 import { compareValues } from '../_internal/compareValues.mjs';
 import { isKey } from '../_internal/isKey.mjs';
-import { toPath } from '../_internal/toPath.mjs';
+import { toPath } from '../util/toPath.mjs';
 
 function orderBy(collection, criteria, orders) {
     if (collection == null || typeof collection === 'number') {

package/dist/compat/index.d.mts

@@ -135,6 +135,7 @@ export { mapValues } from './object/mapValues.mjs';
 export { merge } from './object/merge.mjs';
 export { mergeWith } from './object/mergeWith.mjs';
 export { fromPairs } from './object/fromPairs.mjs';
+export { unset } from './object/unset.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
 export { isArray } from './predicate/isArray.mjs';
 export { isArguments } from './predicate/isArguments.mjs';
@@ -165,7 +166,6 @@ export { endsWith } from './string/endsWith.mjs';
 export { padStart } from './string/padStart.mjs';
 export { padEnd } from './string/padEnd.mjs';
 export { repeat } from './string/repeat.mjs';
-export { toString } from './string/toString.mjs';
 export { trim } from './string/trim.mjs';
 export { trimStart } from './string/trimStart.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
@@ -175,3 +175,5 @@ export { ceil } from './math/ceil.mjs';
 export { floor } from './math/floor.mjs';
 export { round } from './math/round.mjs';
 export { parseInt } from './math/parseInt.mjs';
+export { toPath } from './util/toPath.mjs';
+export { toString } from './util/toString.mjs';

package/dist/compat/index.d.ts

@@ -135,6 +135,7 @@ export { mapValues } from './object/mapValues.js';
 export { merge } from './object/merge.js';
 export { mergeWith } from './object/mergeWith.js';
 export { fromPairs } from './object/fromPairs.js';
+export { unset } from './object/unset.js';
 export { isPlainObject } from './predicate/isPlainObject.js';
 export { isArray } from './predicate/isArray.js';
 export { isArguments } from './predicate/isArguments.js';
@@ -165,7 +166,6 @@ export { endsWith } from './string/endsWith.js';
 export { padStart } from './string/padStart.js';
 export { padEnd } from './string/padEnd.js';
 export { repeat } from './string/repeat.js';
-export { toString } from './string/toString.js';
 export { trim } from './string/trim.js';
 export { trimStart } from './string/trimStart.js';
 export { trimEnd } from './string/trimEnd.js';
@@ -175,3 +175,5 @@ export { ceil } from './math/ceil.js';
 export { floor } from './math/floor.js';
 export { round } from './math/round.js';
 export { parseInt } from './math/parseInt.js';
+export { toPath } from './util/toPath.js';
+export { toString } from './util/toString.js';

package/dist/compat/index.js

@@ -972,6 +972,24 @@ function fromPairs(pairs) {
     return result;
 }
 
+function unset(obj, path) {
+    if (obj == null) {
+        return true;
+    }
+    const resolvedPath = Array.isArray(path) ? path : typeof path === 'string' ? toPath(path) : [path];
+    const parent = get(obj, resolvedPath.slice(0, -1), obj);
+    const lastKey = toKey(resolvedPath[resolvedPath.length - 1]);
+    if (typeof parent !== 'object' || parent == null || !Object.prototype.hasOwnProperty.call(parent, lastKey)) {
+        return true;
+    }
+    const isDeletable = Object.getOwnPropertyDescriptor(parent, lastKey)?.configurable;
+    if (!isDeletable) {
+        return false;
+    }
+    delete parent[lastKey];
+    return true;
+}
+
 function isArray(value) {
     return Array.isArray(value);
 }
@@ -1092,20 +1110,6 @@ function repeat(str, n) {
     return str.repeat(n);
 }
 
-function toString(value) {
-    if (value == null) {
-        return '';
-    }
-    if (Array.isArray(value)) {
-        return value.map(toString).join(',');
-    }
-    const result = String(value);
-    if (result === '0' && Object.is(Number(value), -0)) {
-        return '-0';
-    }
-    return result;
-}
-
 function trim(str, chars, guard) {
     if (str == null) {
         return '';
@@ -1233,6 +1237,20 @@ function parseInt(string, radix = 0, guard) {
     return Number.parseInt(string, radix);
 }
 
+function toString(value) {
+    if (value == null) {
+        return '';
+    }
+    if (Array.isArray(value)) {
+        return value.map(toString).join(',');
+    }
+    const result = String(value);
+    if (result === '0' && Object.is(Number(value), -0)) {
+        return '-0';
+    }
+    return result;
+}
+
 exports.at = zipWith.at;
 exports.compact = zipWith.compact;
 exports.countBy = zipWith.countBy;
@@ -1406,8 +1424,10 @@ exports.sortBy = sortBy;
 exports.spread = spread;
 exports.startCase = startCase;
 exports.startsWith = startsWith;
+exports.toPath = toPath;
 exports.toString = toString;
 exports.trim = trim;
 exports.trimEnd = trimEnd;
 exports.trimStart = trimStart;
+exports.unset = unset;
 exports.zipObjectDeep = zipObjectDeep;

package/dist/compat/index.mjs

@@ -136,6 +136,7 @@ export { mapValues } from './object/mapValues.mjs';
 export { merge } from './object/merge.mjs';
 export { mergeWith } from './object/mergeWith.mjs';
 export { fromPairs } from './object/fromPairs.mjs';
+export { unset } from './object/unset.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
 export { isArray } from './predicate/isArray.mjs';
 export { isArguments } from './predicate/isArguments.mjs';
@@ -165,7 +166,6 @@ export { endsWith } from './string/endsWith.mjs';
 export { padStart } from './string/padStart.mjs';
 export { padEnd } from './string/padEnd.mjs';
 export { repeat } from './string/repeat.mjs';
-export { toString } from './string/toString.mjs';
 export { trim } from './string/trim.mjs';
 export { trimStart } from './string/trimStart.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
@@ -175,3 +175,5 @@ export { ceil } from './math/ceil.mjs';
 export { floor } from './math/floor.mjs';
 export { round } from './math/round.mjs';
 export { parseInt } from './math/parseInt.mjs';
+export { toPath } from './util/toPath.mjs';
+export { toString } from './util/toString.mjs';

package/dist/compat/object/get.mjs

@@ -1,6 +1,6 @@
 import { isDeepKey } from '../_internal/isDeepKey.mjs';
 import { toKey } from '../_internal/toKey.mjs';
-import { toPath } from '../_internal/toPath.mjs';
+import { toPath } from '../util/toPath.mjs';
 
 function get(object, path, defaultValue) {
     let resolvedPath;

package/dist/compat/object/has.mjs

@@ -1,6 +1,6 @@
 import { isDeepKey } from '../_internal/isDeepKey.mjs';
 import { isIndex } from '../_internal/isIndex.mjs';
-import { toPath } from '../_internal/toPath.mjs';
+import { toPath } from '../util/toPath.mjs';
 import { isArguments } from '../predicate/isArguments.mjs';
 
 function has(object, path) {

package/dist/compat/object/set.mjs

@@ -1,5 +1,5 @@
 import { isIndex } from '../_internal/isIndex.mjs';
-import { toPath } from '../_internal/toPath.mjs';
+import { toPath } from '../util/toPath.mjs';
 
 function set(obj, path, value) {
     const resolvedPath = Array.isArray(path) ? path : typeof path === 'string' ? toPath(path) : [path];

package/dist/compat/object/unset.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Removes the property at the given path of the object.
+ *
+ * @param {unknown} obj - The object to modify.
+ * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to unset.
+ * @returns {boolean} - 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: {} } }
+ */
+declare function unset(obj: unknown, path: PropertyKey | readonly PropertyKey[]): boolean;
+
+export { unset };

package/dist/compat/object/unset.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Removes the property at the given path of the object.
+ *
+ * @param {unknown} obj - The object to modify.
+ * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to unset.
+ * @returns {boolean} - 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: {} } }
+ */
+declare function unset(obj: unknown, path: PropertyKey | readonly PropertyKey[]): boolean;
+
+export { unset };

package/dist/compat/object/unset.mjs

@@ -0,0 +1,23 @@
+import { toKey } from '../_internal/toKey.mjs';
+import { toPath } from '../util/toPath.mjs';
+import { get } from './get.mjs';
+
+function unset(obj, path) {
+    if (obj == null) {
+        return true;
+    }
+    const resolvedPath = Array.isArray(path) ? path : typeof path === 'string' ? toPath(path) : [path];
+    const parent = get(obj, resolvedPath.slice(0, -1), obj);
+    const lastKey = toKey(resolvedPath[resolvedPath.length - 1]);
+    if (typeof parent !== 'object' || parent == null || !Object.prototype.hasOwnProperty.call(parent, lastKey)) {
+        return true;
+    }
+    const isDeletable = Object.getOwnPropertyDescriptor(parent, lastKey)?.configurable;
+    if (!isDeletable) {
+        return false;
+    }
+    delete parent[lastKey];
+    return true;
+}
+
+export { unset };

package/dist/compat/util/toPath.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Converts a deep key string into an array of path segments.
+ *
+ * This function takes a string representing a deep key (e.g., 'a.b.c' or 'a[b][c]') and breaks it down into an array of strings, each representing a segment of the path.
+ *
+ * @param {string} deepKey - The deep key string to convert.
+ * @returns {string[]} An array of strings, each representing a segment of the path.
+ *
+ * Examples:
+ *
+ * toPath('a.b.c') // Returns ['a', 'b', 'c']
+ * toPath('a[b][c]') // Returns ['a', 'b', 'c']
+ * toPath('.a.b.c') // Returns ['', 'a', 'b', 'c']
+ * toPath('a["b.c"].d') // Returns ['a', 'b.c', 'd']
+ * toPath('') // Returns []
+ * toPath('.a[b].c.d[e]["f.g"].h') // Returns ['', 'a', 'b', 'c', 'd', 'e', 'f.g', 'h']
+ */
+declare function toPath(deepKey: string): string[];
+
+export { toPath };

package/dist/compat/util/toPath.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Converts a deep key string into an array of path segments.
+ *
+ * This function takes a string representing a deep key (e.g., 'a.b.c' or 'a[b][c]') and breaks it down into an array of strings, each representing a segment of the path.
+ *
+ * @param {string} deepKey - The deep key string to convert.
+ * @returns {string[]} An array of strings, each representing a segment of the path.
+ *
+ * Examples:
+ *
+ * toPath('a.b.c') // Returns ['a', 'b', 'c']
+ * toPath('a[b][c]') // Returns ['a', 'b', 'c']
+ * toPath('.a.b.c') // Returns ['', 'a', 'b', 'c']
+ * toPath('a["b.c"].d') // Returns ['a', 'b.c', 'd']
+ * toPath('') // Returns []
+ * toPath('.a[b].c.d[e]["f.g"].h') // Returns ['', 'a', 'b', 'c', 'd', 'e', 'f.g', 'h']
+ */
+declare function toPath(deepKey: string): string[];
+
+export { toPath };

package/dist/string/index.js

@@ -70,7 +70,7 @@ function pascalCase(str) {
 }
 
 function trimStart(str, chars) {
-    if (chars == null) {
+    if (chars === undefined) {
         return str.trimStart();
     }
     let startIndex = 0;
@@ -91,7 +91,7 @@ function trimStart(str, chars) {
 }
 
 function trimEnd(str, chars) {
-    if (chars == null) {
+    if (chars === undefined) {
         return str.trimEnd();
     }
     let endIndex = str.length;
@@ -112,7 +112,7 @@ function trimEnd(str, chars) {
 }
 
 function trim(str, chars) {
-    if (chars == null) {
+    if (chars === undefined) {
         return str.trim();
     }
     return trimStart(trimEnd(str, chars), chars);

package/dist/string/trim.mjs

@@ -2,7 +2,7 @@ import { trimStart } from './trimStart.mjs';
 import { trimEnd } from './trimEnd.mjs';
 
 function trim(str, chars) {
-    if (chars == null) {
+    if (chars === undefined) {
         return str.trim();
     }
     return trimStart(trimEnd(str, chars), chars);

package/dist/string/trimEnd.mjs

@@ -1,5 +1,5 @@
 function trimEnd(str, chars) {
-    if (chars == null) {
+    if (chars === undefined) {
         return str.trimEnd();
     }
     let endIndex = str.length;

package/dist/string/trimStart.mjs

@@ -1,5 +1,5 @@
 function trimStart(str, chars) {
-    if (chars == null) {
+    if (chars === undefined) {
         return str.trimStart();
     }
     let startIndex = 0;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.18.0-dev.596+6e071573",
+  "version": "1.18.0-dev.600+f2f4b8ec",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {