@ntnyq/utils 0.3.1 → 0.3.3

package/dist/index.cjs

@@ -15,6 +15,7 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -23,15 +24,14 @@ __export(src_exports, {
   NOOP: () => NOOP,
   at: () => at,
   cAF: () => cAF,
-  camelCase: () => camelCase,
   capitalize: () => capitalize,
   chunk: () => chunk,
   clamp: () => clamp,
+  cleanObject: () => cleanObject,
   days: () => days,
   debounce: () => debounce,
   ensurePrefix: () => ensurePrefix,
   ensureSuffix: () => ensureSuffix,
-  flatCase: () => flatCase,
   flattenArrayable: () => flattenArrayable,
   getObjectType: () => getObjectType,
   hasOwn: () => hasOwn,
@@ -40,10 +40,14 @@ __export(src_exports, {
   isArrayEqual: () => isArrayEqual,
   isBoolean: () => isBoolean,
   isBrowser: () => isBrowser,
+  isDeepEqual: () => isDeepEqual,
+  isEmptyArray: () => isEmptyArray,
+  isEmptyObject: () => isEmptyObject,
   isEmptyString: () => isEmptyString,
   isEmptyStringOrWhitespace: () => isEmptyStringOrWhitespace,
   isFunction: () => isFunction,
   isInteger: () => isInteger,
+  isNaN: () => isNaN,
   isNativePromise: () => isNativePromise,
   isNil: () => isNil,
   isNonEmptyString: () => isNonEmptyString,
@@ -56,49 +60,79 @@ __export(src_exports, {
   isSet: () => isSet,
   isString: () => isString,
   isUndefined: () => isUndefined,
-  isUppercase: () => isUppercase,
   isWhitespaceString: () => isWhitespaceString,
+  isZero: () => isZero,
   join: () => join,
-  kebabCase: () => kebabCase,
   last: () => last,
-  lowerFirst: () => lowerFirst,
   mergeArrayable: () => mergeArrayable,
   minutes: () => minutes,
   noop: () => noop,
   omit: () => omit,
   once: () => once,
-  pascalCase: () => pascalCase,
   pick: () => pick,
   rAF: () => rAF,
   seconds: () => seconds,
   slash: () => slash,
-  snakeCase: () => snakeCase,
   sortObject: () => sortObject,
-  splitByCase: () => splitByCase,
   throttle: () => throttle,
-  titleCase: () => titleCase,
   toArray: () => toArray,
-  trainCase: () => trainCase,
   unindent: () => unindent,
   unique: () => unique,
   uniqueBy: () => uniqueBy,
-  upperFirst: () => upperFirst,
   waitFor: () => waitFor,
   warnOnce: () => warnOnce,
   weeks: () => weeks
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/is/isDeepEqual.ts
+function isDeepEqual(value1, value2) {
+  const type1 = getObjectType(value1);
+  const type2 = getObjectType(value2);
+  if (type1 !== type2) {
+    return false;
+  }
+  if (isArray(value1)) {
+    if (value1.length !== value2.length) {
+      return false;
+    }
+    return value1.every((item, index) => isDeepEqual(item, value2[index]));
+  }
+  if (isObject(value1)) {
+    const keys = Object.keys(value1);
+    if (keys.length !== Object.keys(value2).length) {
+      return false;
+    }
+    return keys.every((key) => isDeepEqual(value1[key], value2[key]));
+  }
+  return Object.is(value1, value2);
+}
+
 // src/is/index.ts
 function getObjectType(value) {
   return Object.prototype.toString.call(value).slice(8, -1);
 }
+function isUndefined(value) {
+  return value === void 0;
+}
+function isNull(value) {
+  return value === null;
+}
+function isNil(value) {
+  return isNull(value) || isUndefined(value);
+}
 function isString(value) {
   return typeof value === "string";
 }
 function isNumber(value) {
   return typeof value === "number";
 }
+function isZero(value) {
+  return value === 0;
+}
+function isNaN(value) {
+  return Number.isNaN(value);
+}
 function isEmptyString(value) {
   return isString(value) && value.length === 0;
 }
@@ -126,18 +160,15 @@ function isFunction(value) {
 function isArray(value) {
   return Array.isArray(value);
 }
-function isUndefined(value) {
-  return value === void 0;
-}
-function isNull(value) {
-  return value === null;
-}
-function isNil(value) {
-  return isNull(value) || isUndefined(value);
+function isEmptyArray(value) {
+  return isArray(value) && value.length === 0;
 }
 function isObject(value) {
   return getObjectType(value) === "Object";
 }
+function isEmptyObject(value) {
+  return isObject(value) && Object.keys(value).length === 0;
+}
 function isRegExp(value) {
   return getObjectType(value) === "RegExp";
 }
@@ -175,89 +206,6 @@ function once(func) {
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
-// node_modules/.pnpm/scule@1.3.0/node_modules/scule/dist/index.mjs
-var NUMBER_CHAR_RE = /\d/;
-var STR_SPLITTERS = ["-", "_", "/", "."];
-function isUppercase(char = "") {
-  if (NUMBER_CHAR_RE.test(char)) {
-    return void 0;
-  }
-  return char !== char.toLowerCase();
-}
-function splitByCase(str, separators) {
-  const splitters = separators ?? STR_SPLITTERS;
-  const parts = [];
-  if (!str || typeof str !== "string") {
-    return parts;
-  }
-  let buff = "";
-  let previousUpper;
-  let previousSplitter;
-  for (const char of str) {
-    const isSplitter = splitters.includes(char);
-    if (isSplitter === true) {
-      parts.push(buff);
-      buff = "";
-      previousUpper = void 0;
-      continue;
-    }
-    const isUpper = isUppercase(char);
-    if (previousSplitter === false) {
-      if (previousUpper === false && isUpper === true) {
-        parts.push(buff);
-        buff = char;
-        previousUpper = isUpper;
-        continue;
-      }
-      if (previousUpper === true && isUpper === false && buff.length > 1) {
-        const lastChar = buff.at(-1);
-        parts.push(buff.slice(0, Math.max(0, buff.length - 1)));
-        buff = lastChar + char;
-        previousUpper = isUpper;
-        continue;
-      }
-    }
-    buff += char;
-    previousUpper = isUpper;
-    previousSplitter = isSplitter;
-  }
-  parts.push(buff);
-  return parts;
-}
-function upperFirst(str) {
-  return str ? str[0].toUpperCase() + str.slice(1) : "";
-}
-function lowerFirst(str) {
-  return str ? str[0].toLowerCase() + str.slice(1) : "";
-}
-function pascalCase(str, opts) {
-  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
-}
-function camelCase(str, opts) {
-  return lowerFirst(pascalCase(str || "", opts));
-}
-function kebabCase(str, joiner) {
-  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
-}
-function snakeCase(str) {
-  return kebabCase(str || "", "_");
-}
-function flatCase(str) {
-  return kebabCase(str || "", "");
-}
-function trainCase(str, opts) {
-  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("-");
-}
-var titleCaseExceptions = /^(a|an|and|as|at|but|by|for|if|in|is|nor|of|on|or|the|to|with)$/i;
-function titleCase(str, opts) {
-  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map(
-    (p) => titleCaseExceptions.test(p) ? p.toLowerCase() : upperFirst(opts?.normalize ? p.toLowerCase() : p)
-  ).join(" ");
-}
-
-// src/case.ts
-var capitalize = upperFirst;
-
 // src/misc/raf.ts
 var root = isBrowser() ? window : globalThis;
 var prev = Date.now();
@@ -477,6 +425,9 @@ function omit(object, ...keys) {
 
 // src/object/hasOwn.ts
 function hasOwn(object, key) {
+  if (object === null) {
+    return false;
+  }
   return Object.prototype.hasOwnProperty.call(object, key);
 }
 
@@ -492,6 +443,48 @@ function pick(object, keys) {
   );
 }
 
+// src/object/clean.ts
+function cleanObject(obj, options = {}) {
+  const {
+    cleanUndefined = true,
+    cleanNull = true,
+    cleanZero = false,
+    cleanNaN = true,
+    cleanEmptyString = true,
+    cleanEmptyArray = true,
+    cleanEmptyObject = true,
+    recursive = true
+  } = options;
+  Object.keys(obj).forEach((key) => {
+    const v = obj[key];
+    if (cleanUndefined && isUndefined(v)) {
+      delete obj[key];
+    }
+    if (cleanNull && isNull(v)) {
+      delete obj[key];
+    }
+    if (cleanZero && isZero(v)) {
+      delete obj[key];
+    }
+    if (cleanNaN && isZero(v)) {
+      delete obj[key];
+    }
+    if (cleanEmptyString && isEmptyString(v)) {
+      delete obj[key];
+    }
+    if (cleanEmptyArray && isEmptyArray(v)) {
+      delete obj[key];
+    }
+    if (cleanEmptyObject && isEmptyObject(v)) {
+      delete obj[key];
+    }
+    if (recursive && isObject(v)) {
+      cleanObject(v, options);
+    }
+  });
+  return obj;
+}
+
 // src/object/isPlainObject.ts
 function isPlainObject(value) {
   if (!isObject(value)) return false;
@@ -522,20 +515,40 @@ function sortObject(obj, options = {}) {
   }
   return sortKeys(obj);
 }
+
+// src/vendor/index.ts
+var vendor_exports = {};
+__export(vendor_exports, {
+  capitalize: () => capitalize
+});
+
+// src/vendor/scule.ts
+var scule_exports = {};
+__export(scule_exports, {
+  capitalize: () => capitalize
+});
+var import_scule = require("scule");
+__reExport(scule_exports, require("scule"));
+var capitalize = import_scule.upperFirst;
+
+// src/vendor/index.ts
+__reExport(vendor_exports, scule_exports);
+
+// src/index.ts
+__reExport(src_exports, vendor_exports, module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NOOP,
   at,
   cAF,
-  camelCase,
   capitalize,
   chunk,
   clamp,
+  cleanObject,
   days,
   debounce,
   ensurePrefix,
   ensureSuffix,
-  flatCase,
   flattenArrayable,
   getObjectType,
   hasOwn,
@@ -544,10 +557,14 @@ function sortObject(obj, options = {}) {
   isArrayEqual,
   isBoolean,
   isBrowser,
+  isDeepEqual,
+  isEmptyArray,
+  isEmptyObject,
   isEmptyString,
   isEmptyStringOrWhitespace,
   isFunction,
   isInteger,
+  isNaN,
   isNativePromise,
   isNil,
   isNonEmptyString,
@@ -560,33 +577,25 @@ function sortObject(obj, options = {}) {
   isSet,
   isString,
   isUndefined,
-  isUppercase,
   isWhitespaceString,
+  isZero,
   join,
-  kebabCase,
   last,
-  lowerFirst,
   mergeArrayable,
   minutes,
   noop,
   omit,
   once,
-  pascalCase,
   pick,
   rAF,
   seconds,
   slash,
-  snakeCase,
   sortObject,
-  splitByCase,
   throttle,
-  titleCase,
   toArray,
-  trainCase,
   unindent,
   unique,
   uniqueBy,
-  upperFirst,
   waitFor,
   warnOnce,
   weeks

package/dist/index.d.cts

@@ -1,9 +1,14 @@
 import { upperFirst } from 'scule';
 export * from 'scule';
 
+/**
+ * check if two values are deeply equal
+ */
+declare function isDeepEqual(value1: any, value2: any): boolean;
+
 /**
  * @file is utils
- * @category is
+ * @module is
  * @copyright {@link https://github.com/sindresorhus/is}
  */
 type Whitespace = ' ';
@@ -11,8 +16,13 @@ type NonEmptyString = string & {
     0: '';
 };
 declare function getObjectType(value: unknown): string;
+declare function isUndefined(value: unknown): value is undefined;
+declare function isNull(value: unknown): value is null;
+declare function isNil(value: unknown): value is null | undefined;
 declare function isString(value: unknown): value is string;
 declare function isNumber(value: unknown): value is number;
+declare function isZero(value: unknown): value is 0;
+declare function isNaN(value: unknown): value is typeof Number.NaN;
 declare function isEmptyString(value: unknown): value is '';
 declare function isNonEmptyString(value: unknown): value is NonEmptyString;
 declare function isWhitespaceString(value: unknown): value is Whitespace;
@@ -22,10 +32,9 @@ declare function isInteger(value: unknown): value is number;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
-declare function isUndefined(value: unknown): value is undefined;
-declare function isNull(value: unknown): value is null;
-declare function isNil(value: unknown): value is null | undefined;
+declare function isEmptyArray(value: unknown): value is [];
 declare function isObject(value: unknown): value is object;
+declare function isEmptyObject(value: unknown): value is {};
 declare function isRegExp(value: unknown): value is RegExp;
 declare function isSet<Value = unknown>(value: unknown): value is Set<Value>;
 declare function isNativePromise<T = unknown>(value: unknown): value is Promise<T>;
@@ -52,36 +61,27 @@ declare function once<T extends unknown[]>(func: (...args: T) => void): (this: u
  */
 declare const isBrowser: () => boolean;
 
-/**
- * @file case utils
- * @category Case
- */
-
-/**
- * @deprecated use upperFirst instead
- */
-declare const capitalize: typeof upperFirst;
-
 /**
  * @file raf.ts
  */
 /**
  * Request animation frame
  *
- * @param fn callback
+ * @param fn - callback
  * @returns id
  */
 declare function rAF(fn: FrameRequestCallback): number;
 /**
  * Cancel animation frame
  *
- * @param id id
+ * @param id - id
  * @returns void
  */
 declare function cAF(id: number): void;
 
 /**
- * @category Utils - time
+ * @file time utils
+ * @module Time
  */
 declare function seconds(count: number): number;
 declare function minutes(count: number): number;
@@ -91,9 +91,9 @@ declare function weeks(count: number): number;
 
 /**
  * Clamps a number between a minimum and maximum value
- * @param value the value to clamp within the given range
- * @param min the minimum value to clamp
- * @param max the maximum value to clamp
+ * @param value - the value to clamp within the given range
+ * @param min - the minimum value to clamp
+ * @param max - the maximum value to clamp
  * @returns the new value
  */
 declare function clamp(value: number, min?: number, max?: number): number;
@@ -101,7 +101,7 @@ declare function clamp(value: number, min?: number, max?: number): number;
 /**
  * Wait for a number of milliseconds
  *
- * @param ms millseconds to wait
+ * @param ms - millseconds to wait
  * @returns a promise that resolves after ms milliseconds
  *
  * @example
@@ -152,8 +152,8 @@ declare function last<T>(array: readonly T[]): T | undefined;
 
 /**
  * Splits an array into smaller chunks of a given size.
- * @param array The array to split
- * @param size The size of each chunk
+ * @param array - The array to split
+ * @param size - The size of each chunk
  * @returns An array of arrays, where each sub-array has `size` elements from the original array.
  */
 declare function chunk<T>(array: T[], size: number): T[][];
@@ -172,16 +172,34 @@ declare function unique<T>(array: T[]): T[];
  */
 declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
-type Nullable<T> = T | null;
-type MayBe<T> = T | undefined;
+/**
+ * interop module
+ */
+type InteropModuleDefault<T> = T extends {
+    default: infer U;
+} ? U : T;
+
 type AnyFn<T = any, R = any> = (...args: T[]) => R;
 type Arrayable<T> = T | T[];
-type Awaitable<T> = T | Promise<T>;
+type Awaitable<T> = Promise<T> | T;
+type MayBe<T> = T | undefined;
+type Nullable<T> = T | null;
+type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
+/**
+ * Prettify object type
+ */
 type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type PrettifyV2<T> = Omit<T, never>;
-type PrimitiveType = number | bigint | string | boolean | symbol | null | undefined;
+/**
+ * Overwrite some keys type
+ */
+type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
+/**
+ * Resolve `boolean | Record<string, any>` to `Record<string, any>`
+ */
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 
 /**
  * Converts a value to an array.
@@ -228,7 +246,7 @@ declare function slash(input: string): string;
 /**
  * Remove leading whitespace from a template string
  * Empty lines at the beginning and end of the template string are also removed.
- * @param input template string
+ * @param input - template string
  *
  * @example
  *
@@ -250,7 +268,71 @@ declare function omit<T, K extends keyof T>(object: T, ...keys: K[]): Omit<T, K>
 
 declare function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K>;
 
-declare function hasOwn<T, K extends keyof T>(object: T, key: K): boolean;
+interface CleanObjectOptions {
+    /**
+     * clean undefined
+     *
+     * @default true
+     */
+    cleanUndefined?: boolean;
+    /**
+     * clean null
+     *
+     * @default true
+     */
+    cleanNull?: boolean;
+    /**
+     * clean zero
+     *
+     * @default false
+     */
+    cleanZero?: boolean;
+    /**
+     * clean NaN
+     *
+     * @default true
+     */
+    cleanNaN?: boolean;
+    /**
+     * clean empty string
+     *
+     * @default true
+     */
+    cleanEmptyString?: boolean;
+    /**
+     * clean empty array
+     *
+     * @default true
+     */
+    cleanEmptyArray?: boolean;
+    /**
+     * clean empty object
+     *
+     * @default true
+     */
+    cleanEmptyObject?: boolean;
+    /**
+     * recursive clean object
+     *
+     * @default true
+     */
+    recursive?: boolean;
+}
+/**
+ * clean undefined, null, zero, empty string, empty array, empty object from object
+ * @param obj - object to be cleaned
+ * @param options - clean options
+ * @returns cleaned object
+ */
+declare function cleanObject<T extends object>(obj: T, options?: CleanObjectOptions): T;
+
+/**
+ * check object has a property with given key
+ * @param object - the object to check
+ * @param key - the key to check
+ * @returns true if object has a property with given key, false otherwise
+ */
+declare function hasOwn<T>(object: T, key: PropertyKey): boolean;
 
 interface SortObjectOptions {
     /**
@@ -268,4 +350,14 @@ interface SortObjectOptions {
  */
 declare function sortObject<T extends Record<string, any>>(obj: T, options?: SortObjectOptions): T;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type NonEmptyString, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+/**
+ * @file case utils
+ * @module vendor
+ */
+
+/**
+ * @deprecated use upperFirst instead
+ */
+declare const capitalize: typeof upperFirst;
+
+export { type AnyFn, type Arrayable, type Awaitable, type CleanObjectOptions, type InteropModuleDefault, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -1,9 +1,14 @@
 import { upperFirst } from 'scule';
 export * from 'scule';
 
+/**
+ * check if two values are deeply equal
+ */
+declare function isDeepEqual(value1: any, value2: any): boolean;
+
 /**
  * @file is utils
- * @category is
+ * @module is
  * @copyright {@link https://github.com/sindresorhus/is}
  */
 type Whitespace = ' ';
@@ -11,8 +16,13 @@ type NonEmptyString = string & {
     0: '';
 };
 declare function getObjectType(value: unknown): string;
+declare function isUndefined(value: unknown): value is undefined;
+declare function isNull(value: unknown): value is null;
+declare function isNil(value: unknown): value is null | undefined;
 declare function isString(value: unknown): value is string;
 declare function isNumber(value: unknown): value is number;
+declare function isZero(value: unknown): value is 0;
+declare function isNaN(value: unknown): value is typeof Number.NaN;
 declare function isEmptyString(value: unknown): value is '';
 declare function isNonEmptyString(value: unknown): value is NonEmptyString;
 declare function isWhitespaceString(value: unknown): value is Whitespace;
@@ -22,10 +32,9 @@ declare function isInteger(value: unknown): value is number;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
-declare function isUndefined(value: unknown): value is undefined;
-declare function isNull(value: unknown): value is null;
-declare function isNil(value: unknown): value is null | undefined;
+declare function isEmptyArray(value: unknown): value is [];
 declare function isObject(value: unknown): value is object;
+declare function isEmptyObject(value: unknown): value is {};
 declare function isRegExp(value: unknown): value is RegExp;
 declare function isSet<Value = unknown>(value: unknown): value is Set<Value>;
 declare function isNativePromise<T = unknown>(value: unknown): value is Promise<T>;
@@ -52,36 +61,27 @@ declare function once<T extends unknown[]>(func: (...args: T) => void): (this: u
  */
 declare const isBrowser: () => boolean;
 
-/**
- * @file case utils
- * @category Case
- */
-
-/**
- * @deprecated use upperFirst instead
- */
-declare const capitalize: typeof upperFirst;
-
 /**
  * @file raf.ts
  */
 /**
  * Request animation frame
  *
- * @param fn callback
+ * @param fn - callback
  * @returns id
  */
 declare function rAF(fn: FrameRequestCallback): number;
 /**
  * Cancel animation frame
  *
- * @param id id
+ * @param id - id
  * @returns void
  */
 declare function cAF(id: number): void;
 
 /**
- * @category Utils - time
+ * @file time utils
+ * @module Time
  */
 declare function seconds(count: number): number;
 declare function minutes(count: number): number;
@@ -91,9 +91,9 @@ declare function weeks(count: number): number;
 
 /**
  * Clamps a number between a minimum and maximum value
- * @param value the value to clamp within the given range
- * @param min the minimum value to clamp
- * @param max the maximum value to clamp
+ * @param value - the value to clamp within the given range
+ * @param min - the minimum value to clamp
+ * @param max - the maximum value to clamp
  * @returns the new value
  */
 declare function clamp(value: number, min?: number, max?: number): number;
@@ -101,7 +101,7 @@ declare function clamp(value: number, min?: number, max?: number): number;
 /**
  * Wait for a number of milliseconds
  *
- * @param ms millseconds to wait
+ * @param ms - millseconds to wait
  * @returns a promise that resolves after ms milliseconds
  *
  * @example
@@ -152,8 +152,8 @@ declare function last<T>(array: readonly T[]): T | undefined;
 
 /**
  * Splits an array into smaller chunks of a given size.
- * @param array The array to split
- * @param size The size of each chunk
+ * @param array - The array to split
+ * @param size - The size of each chunk
  * @returns An array of arrays, where each sub-array has `size` elements from the original array.
  */
 declare function chunk<T>(array: T[], size: number): T[][];
@@ -172,16 +172,34 @@ declare function unique<T>(array: T[]): T[];
  */
 declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
-type Nullable<T> = T | null;
-type MayBe<T> = T | undefined;
+/**
+ * interop module
+ */
+type InteropModuleDefault<T> = T extends {
+    default: infer U;
+} ? U : T;
+
 type AnyFn<T = any, R = any> = (...args: T[]) => R;
 type Arrayable<T> = T | T[];
-type Awaitable<T> = T | Promise<T>;
+type Awaitable<T> = Promise<T> | T;
+type MayBe<T> = T | undefined;
+type Nullable<T> = T | null;
+type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
+/**
+ * Prettify object type
+ */
 type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type PrettifyV2<T> = Omit<T, never>;
-type PrimitiveType = number | bigint | string | boolean | symbol | null | undefined;
+/**
+ * Overwrite some keys type
+ */
+type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
+/**
+ * Resolve `boolean | Record<string, any>` to `Record<string, any>`
+ */
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 
 /**
  * Converts a value to an array.
@@ -228,7 +246,7 @@ declare function slash(input: string): string;
 /**
  * Remove leading whitespace from a template string
  * Empty lines at the beginning and end of the template string are also removed.
- * @param input template string
+ * @param input - template string
  *
  * @example
  *
@@ -250,7 +268,71 @@ declare function omit<T, K extends keyof T>(object: T, ...keys: K[]): Omit<T, K>
 
 declare function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K>;
 
-declare function hasOwn<T, K extends keyof T>(object: T, key: K): boolean;
+interface CleanObjectOptions {
+    /**
+     * clean undefined
+     *
+     * @default true
+     */
+    cleanUndefined?: boolean;
+    /**
+     * clean null
+     *
+     * @default true
+     */
+    cleanNull?: boolean;
+    /**
+     * clean zero
+     *
+     * @default false
+     */
+    cleanZero?: boolean;
+    /**
+     * clean NaN
+     *
+     * @default true
+     */
+    cleanNaN?: boolean;
+    /**
+     * clean empty string
+     *
+     * @default true
+     */
+    cleanEmptyString?: boolean;
+    /**
+     * clean empty array
+     *
+     * @default true
+     */
+    cleanEmptyArray?: boolean;
+    /**
+     * clean empty object
+     *
+     * @default true
+     */
+    cleanEmptyObject?: boolean;
+    /**
+     * recursive clean object
+     *
+     * @default true
+     */
+    recursive?: boolean;
+}
+/**
+ * clean undefined, null, zero, empty string, empty array, empty object from object
+ * @param obj - object to be cleaned
+ * @param options - clean options
+ * @returns cleaned object
+ */
+declare function cleanObject<T extends object>(obj: T, options?: CleanObjectOptions): T;
+
+/**
+ * check object has a property with given key
+ * @param object - the object to check
+ * @param key - the key to check
+ * @returns true if object has a property with given key, false otherwise
+ */
+declare function hasOwn<T>(object: T, key: PropertyKey): boolean;
 
 interface SortObjectOptions {
     /**
@@ -268,4 +350,14 @@ interface SortObjectOptions {
  */
 declare function sortObject<T extends Record<string, any>>(obj: T, options?: SortObjectOptions): T;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type NonEmptyString, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+/**
+ * @file case utils
+ * @module vendor
+ */
+
+/**
+ * @deprecated use upperFirst instead
+ */
+declare const capitalize: typeof upperFirst;
+
+export { type AnyFn, type Arrayable, type Awaitable, type CleanObjectOptions, type InteropModuleDefault, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -1,13 +1,135 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  NOOP: () => NOOP,
+  at: () => at,
+  cAF: () => cAF,
+  capitalize: () => capitalize,
+  chunk: () => chunk,
+  clamp: () => clamp,
+  cleanObject: () => cleanObject,
+  days: () => days,
+  debounce: () => debounce,
+  ensurePrefix: () => ensurePrefix,
+  ensureSuffix: () => ensureSuffix,
+  flattenArrayable: () => flattenArrayable,
+  getObjectType: () => getObjectType,
+  hasOwn: () => hasOwn,
+  hours: () => hours,
+  isArray: () => isArray,
+  isArrayEqual: () => isArrayEqual,
+  isBoolean: () => isBoolean,
+  isBrowser: () => isBrowser,
+  isDeepEqual: () => isDeepEqual,
+  isEmptyArray: () => isEmptyArray,
+  isEmptyObject: () => isEmptyObject,
+  isEmptyString: () => isEmptyString,
+  isEmptyStringOrWhitespace: () => isEmptyStringOrWhitespace,
+  isFunction: () => isFunction,
+  isInteger: () => isInteger,
+  isNaN: () => isNaN,
+  isNativePromise: () => isNativePromise,
+  isNil: () => isNil,
+  isNonEmptyString: () => isNonEmptyString,
+  isNull: () => isNull,
+  isNumber: () => isNumber,
+  isNumbericString: () => isNumbericString,
+  isObject: () => isObject,
+  isPromise: () => isPromise,
+  isRegExp: () => isRegExp,
+  isSet: () => isSet,
+  isString: () => isString,
+  isUndefined: () => isUndefined,
+  isWhitespaceString: () => isWhitespaceString,
+  isZero: () => isZero,
+  join: () => join,
+  last: () => last,
+  mergeArrayable: () => mergeArrayable,
+  minutes: () => minutes,
+  noop: () => noop,
+  omit: () => omit,
+  once: () => once,
+  pick: () => pick,
+  rAF: () => rAF,
+  seconds: () => seconds,
+  slash: () => slash,
+  sortObject: () => sortObject,
+  throttle: () => throttle,
+  toArray: () => toArray,
+  unindent: () => unindent,
+  unique: () => unique,
+  uniqueBy: () => uniqueBy,
+  waitFor: () => waitFor,
+  warnOnce: () => warnOnce,
+  weeks: () => weeks
+});
+
+// src/is/isDeepEqual.ts
+function isDeepEqual(value1, value2) {
+  const type1 = getObjectType(value1);
+  const type2 = getObjectType(value2);
+  if (type1 !== type2) {
+    return false;
+  }
+  if (isArray(value1)) {
+    if (value1.length !== value2.length) {
+      return false;
+    }
+    return value1.every((item, index) => isDeepEqual(item, value2[index]));
+  }
+  if (isObject(value1)) {
+    const keys = Object.keys(value1);
+    if (keys.length !== Object.keys(value2).length) {
+      return false;
+    }
+    return keys.every((key) => isDeepEqual(value1[key], value2[key]));
+  }
+  return Object.is(value1, value2);
+}
+
 // src/is/index.ts
 function getObjectType(value) {
   return Object.prototype.toString.call(value).slice(8, -1);
 }
+function isUndefined(value) {
+  return value === void 0;
+}
+function isNull(value) {
+  return value === null;
+}
+function isNil(value) {
+  return isNull(value) || isUndefined(value);
+}
 function isString(value) {
   return typeof value === "string";
 }
 function isNumber(value) {
   return typeof value === "number";
 }
+function isZero(value) {
+  return value === 0;
+}
+function isNaN(value) {
+  return Number.isNaN(value);
+}
 function isEmptyString(value) {
   return isString(value) && value.length === 0;
 }
@@ -35,18 +157,15 @@ function isFunction(value) {
 function isArray(value) {
   return Array.isArray(value);
 }
-function isUndefined(value) {
-  return value === void 0;
-}
-function isNull(value) {
-  return value === null;
-}
-function isNil(value) {
-  return isNull(value) || isUndefined(value);
+function isEmptyArray(value) {
+  return isArray(value) && value.length === 0;
 }
 function isObject(value) {
   return getObjectType(value) === "Object";
 }
+function isEmptyObject(value) {
+  return isObject(value) && Object.keys(value).length === 0;
+}
 function isRegExp(value) {
   return getObjectType(value) === "RegExp";
 }
@@ -84,89 +203,6 @@ function once(func) {
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
-// node_modules/.pnpm/scule@1.3.0/node_modules/scule/dist/index.mjs
-var NUMBER_CHAR_RE = /\d/;
-var STR_SPLITTERS = ["-", "_", "/", "."];
-function isUppercase(char = "") {
-  if (NUMBER_CHAR_RE.test(char)) {
-    return void 0;
-  }
-  return char !== char.toLowerCase();
-}
-function splitByCase(str, separators) {
-  const splitters = separators ?? STR_SPLITTERS;
-  const parts = [];
-  if (!str || typeof str !== "string") {
-    return parts;
-  }
-  let buff = "";
-  let previousUpper;
-  let previousSplitter;
-  for (const char of str) {
-    const isSplitter = splitters.includes(char);
-    if (isSplitter === true) {
-      parts.push(buff);
-      buff = "";
-      previousUpper = void 0;
-      continue;
-    }
-    const isUpper = isUppercase(char);
-    if (previousSplitter === false) {
-      if (previousUpper === false && isUpper === true) {
-        parts.push(buff);
-        buff = char;
-        previousUpper = isUpper;
-        continue;
-      }
-      if (previousUpper === true && isUpper === false && buff.length > 1) {
-        const lastChar = buff.at(-1);
-        parts.push(buff.slice(0, Math.max(0, buff.length - 1)));
-        buff = lastChar + char;
-        previousUpper = isUpper;
-        continue;
-      }
-    }
-    buff += char;
-    previousUpper = isUpper;
-    previousSplitter = isSplitter;
-  }
-  parts.push(buff);
-  return parts;
-}
-function upperFirst(str) {
-  return str ? str[0].toUpperCase() + str.slice(1) : "";
-}
-function lowerFirst(str) {
-  return str ? str[0].toLowerCase() + str.slice(1) : "";
-}
-function pascalCase(str, opts) {
-  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("") : "";
-}
-function camelCase(str, opts) {
-  return lowerFirst(pascalCase(str || "", opts));
-}
-function kebabCase(str, joiner) {
-  return str ? (Array.isArray(str) ? str : splitByCase(str)).map((p) => p.toLowerCase()).join(joiner ?? "-") : "";
-}
-function snakeCase(str) {
-  return kebabCase(str || "", "_");
-}
-function flatCase(str) {
-  return kebabCase(str || "", "");
-}
-function trainCase(str, opts) {
-  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map((p) => upperFirst(opts?.normalize ? p.toLowerCase() : p)).join("-");
-}
-var titleCaseExceptions = /^(a|an|and|as|at|but|by|for|if|in|is|nor|of|on|or|the|to|with)$/i;
-function titleCase(str, opts) {
-  return (Array.isArray(str) ? str : splitByCase(str)).filter(Boolean).map(
-    (p) => titleCaseExceptions.test(p) ? p.toLowerCase() : upperFirst(opts?.normalize ? p.toLowerCase() : p)
-  ).join(" ");
-}
-
-// src/case.ts
-var capitalize = upperFirst;
-
 // src/misc/raf.ts
 var root = isBrowser() ? window : globalThis;
 var prev = Date.now();
@@ -386,6 +422,9 @@ function omit(object, ...keys) {
 
 // src/object/hasOwn.ts
 function hasOwn(object, key) {
+  if (object === null) {
+    return false;
+  }
   return Object.prototype.hasOwnProperty.call(object, key);
 }
 
@@ -401,6 +440,48 @@ function pick(object, keys) {
   );
 }
 
+// src/object/clean.ts
+function cleanObject(obj, options = {}) {
+  const {
+    cleanUndefined = true,
+    cleanNull = true,
+    cleanZero = false,
+    cleanNaN = true,
+    cleanEmptyString = true,
+    cleanEmptyArray = true,
+    cleanEmptyObject = true,
+    recursive = true
+  } = options;
+  Object.keys(obj).forEach((key) => {
+    const v = obj[key];
+    if (cleanUndefined && isUndefined(v)) {
+      delete obj[key];
+    }
+    if (cleanNull && isNull(v)) {
+      delete obj[key];
+    }
+    if (cleanZero && isZero(v)) {
+      delete obj[key];
+    }
+    if (cleanNaN && isZero(v)) {
+      delete obj[key];
+    }
+    if (cleanEmptyString && isEmptyString(v)) {
+      delete obj[key];
+    }
+    if (cleanEmptyArray && isEmptyArray(v)) {
+      delete obj[key];
+    }
+    if (cleanEmptyObject && isEmptyObject(v)) {
+      delete obj[key];
+    }
+    if (recursive && isObject(v)) {
+      cleanObject(v, options);
+    }
+  });
+  return obj;
+}
+
 // src/object/isPlainObject.ts
 function isPlainObject(value) {
   if (!isObject(value)) return false;
@@ -431,19 +512,40 @@ function sortObject(obj, options = {}) {
   }
   return sortKeys(obj);
 }
+
+// src/vendor/index.ts
+var vendor_exports = {};
+__export(vendor_exports, {
+  capitalize: () => capitalize
+});
+
+// src/vendor/scule.ts
+var scule_exports = {};
+__export(scule_exports, {
+  capitalize: () => capitalize
+});
+__reExport(scule_exports, scule_star);
+import { upperFirst } from "scule";
+import * as scule_star from "scule";
+var capitalize = upperFirst;
+
+// src/vendor/index.ts
+__reExport(vendor_exports, scule_exports);
+
+// src/index.ts
+__reExport(src_exports, vendor_exports);
 export {
   NOOP,
   at,
   cAF,
-  camelCase,
   capitalize,
   chunk,
   clamp,
+  cleanObject,
   days,
   debounce,
   ensurePrefix,
   ensureSuffix,
-  flatCase,
   flattenArrayable,
   getObjectType,
   hasOwn,
@@ -452,10 +554,14 @@ export {
   isArrayEqual,
   isBoolean,
   isBrowser,
+  isDeepEqual,
+  isEmptyArray,
+  isEmptyObject,
   isEmptyString,
   isEmptyStringOrWhitespace,
   isFunction,
   isInteger,
+  isNaN,
   isNativePromise,
   isNil,
   isNonEmptyString,
@@ -468,33 +574,25 @@ export {
   isSet,
   isString,
   isUndefined,
-  isUppercase,
   isWhitespaceString,
+  isZero,
   join,
-  kebabCase,
   last,
-  lowerFirst,
   mergeArrayable,
   minutes,
   noop,
   omit,
   once,
-  pascalCase,
   pick,
   rAF,
   seconds,
   slash,
-  snakeCase,
   sortObject,
-  splitByCase,
   throttle,
-  titleCase,
   toArray,
-  trainCase,
   unindent,
   unique,
   uniqueBy,
-  upperFirst,
   waitFor,
   warnOnce,
   weeks

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -40,23 +40,22 @@
     "scule": "^1.3.0"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^3.2.2",
-    "@ntnyq/prettier-config": "^1.21.3",
-    "@vitest/coverage-v8": "^2.1.5",
+    "@ntnyq/eslint-config": "^3.8.1",
+    "@ntnyq/prettier-config": "^1.22.0",
+    "@vitest/coverage-v8": "^2.1.8",
     "bumpp": "^9.8.1",
-    "eslint": "^9.15.0",
+    "eslint": "^9.16.0",
     "husky": "^9.1.7",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^7.0.1",
-    "prettier": "^3.3.3",
+    "prettier": "^3.4.2",
     "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.5"
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
   },
   "engines": {
     "node": ">=18.18.0"
   },
-  "prettier": "@ntnyq/prettier-config",
   "nano-staged": {
     "*.{js,ts,mjs,cjs,json,md,yml,yaml}": "eslint --fix"
   },