es-toolkit 1.20.0-dev.627 → 1.20.0-dev.628

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

@@ -0,0 +1,49 @@
+/**
+ * Creates a deep clone of the given object.
+ *
+ * @template T - The type of the object.
+ * @param {T} obj - The object to clone.
+ * @returns {T} - A deep clone of the given object.
+ *
+ * @example
+ * // Clone a primitive values
+ * const num = 29;
+ * const clonedNum = clone(num);
+ * console.log(clonedNum); // 29
+ * console.log(clonedNum === num) ; // true
+ *
+ * @example
+ * // Clone an array
+ * const arr = [1, 2, 3];
+ * const clonedArr = clone(arr);
+ * console.log(clonedArr); // [1, 2, 3]
+ * console.log(clonedArr === arr); // false
+ *
+ * @example
+ * // Clone an array with nested objects
+ * const arr = [1, { a: 1 }, [1, 2, 3]];
+ * const clonedArr = clone(arr);
+ * arr[1].a = 2;
+ * console.log(arr); // [2, { a: 2 }, [1, 2, 3]]
+ * console.log(clonedArr); // [1, { a: 1 }, [1, 2, 3]]
+ * console.log(clonedArr === arr); // false
+ *
+ * @example
+ * // Clone an object
+ * const obj = { a: 1, b: 'es-toolkit', c: [1, 2, 3] };
+ * const clonedObj = clone(obj);
+ * console.log(clonedObj); // { a: 1, b: 'es-toolkit', c: [1, 2, 3] }
+ * console.log(clonedObj === obj); // false
+ *
+ * @example
+ * // Clone an object with nested objects
+ * const obj = { a: 1, b: { c: 1 } };
+ * const clonedObj = clone(obj);
+ * obj.b.c = 2;
+ * console.log(obj); // { a: 1, b: { c: 2 } }
+ * console.log(clonedObj); // { a: 1, b: { c: 1 } }
+ * console.log(clonedObj === obj); // false
+ */
+declare function cloneDeep<T>(obj: T): T;
+
+export { cloneDeep };

package/dist/compat/predicate/isArrayLikeObject.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Checks if the given value is a non-primitive, array-like object.
+ *
+ * @param {unknown} value The value to check.
+ * @returns {value is ArrayLike<unknown> & object} `true` if the value is a non-primitive, array-like object, `false` otherwise.
+ *
+ * @example
+ * isArrayLikeObject([1, 2, 3]); // true
+ * isArrayLikeObject({ 0: 'a', length: 1 }); // true
+ * isArrayLikeObject('abc'); // false
+ * isArrayLikeObject(()=>{}); // false
+ */
+declare function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object;
+
+export { isArrayLikeObject };

package/dist/compat/predicate/isArrayLikeObject.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks if the given value is a non-primitive, array-like object.
+ *
+ * @param {unknown} value The value to check.
+ * @returns {value is ArrayLike<unknown> & object} `true` if the value is a non-primitive, array-like object, `false` otherwise.
+ *
+ * @example
+ * isArrayLikeObject([1, 2, 3]); // true
+ * isArrayLikeObject({ 0: 'a', length: 1 }); // true
+ * isArrayLikeObject('abc'); // false
+ * isArrayLikeObject(()=>{}); // false
+ */
+declare function isArrayLikeObject(value: unknown): value is ArrayLike<unknown> & object;
+
+export { isArrayLikeObject };

package/dist/compat/predicate/isArrayLikeObject.mjs

@@ -0,0 +1,8 @@
+import { isArrayLike } from './isArrayLike.mjs';
+import { isObjectLike } from './isObjectLike.mjs';
+
+function isArrayLikeObject(value) {
+    return isObjectLike(value) && isArrayLike(value);
+}
+
+export { isArrayLikeObject };

package/dist/compat/predicate/isNil.d.mts

@@ -0,0 +1,22 @@
+/**
+ * Checks if a given value is null or undefined.
+ *
+ * This function tests whether the provided value is either `null` or `undefined`.
+ * It returns `true` if the value is `null` or `undefined`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
+ *
+ * @param {unknown} x - The value to test for null or undefined.
+ * @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+ *
+ * @example
+ * const value1 = null;
+ * const value2 = undefined;
+ * const value3 = 42;
+ * const result1 = isNil(value1); // true
+ * const result2 = isNil(value2); // true
+ * const result3 = isNil(value3); // false
+ */
+declare function isNil(x?: unknown): x is null | undefined;
+
+export { isNil };

package/dist/compat/predicate/isNil.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Checks if a given value is null or undefined.
+ *
+ * This function tests whether the provided value is either `null` or `undefined`.
+ * It returns `true` if the value is `null` or `undefined`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `null` or `undefined`.
+ *
+ * @param {unknown} x - The value to test for null or undefined.
+ * @returns {boolean} `true` if the value is null or undefined, `false` otherwise.
+ *
+ * @example
+ * const value1 = null;
+ * const value2 = undefined;
+ * const value3 = 42;
+ * const result1 = isNil(value1); // true
+ * const result2 = isNil(value2); // true
+ * const result3 = isNil(value3); // false
+ */
+declare function isNil(x?: unknown): x is null | undefined;
+
+export { isNil };

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.20.0-dev.627+0c4edbb2",
+  "version": "1.20.0-dev.628+0b0ff547",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {