@pawover/kit 0.1.0 → 0.2.0

package/packages/utils/dist/index.d.ts

@@ -26,7 +26,7 @@ declare class ArrayUtil {
    * ```
    */
   static cast<T>(candidate: T | T[] | null | undefined, checkEmpty?: true): NonNullable<T>[];
-  static cast<T>(candidate: T | T[] | null | undefined, checkEmpty?: false): T[];
+  static cast<T>(candidate: T | T[] | null | undefined, checkEmpty: false): T[];
   /**
    * 获取数组第一项
    *
@@ -3717,6 +3717,39 @@ declare class ObjectUtil {
  * 字符串工具类
  */
 declare class StringUtil {
+  /**
+   * 将任意值转换为字符串
+   * - 当传入数值字面量时，返回对应的字符串字面量类型
+   *
+   * @param candidate 待转换的值
+   * @param checkEmpty 是否检查空值（`null` / `undefined` / 空白字符串），默认为 `true`
+   * @returns 转换后的字符串
+   * @example
+   * ```ts
+   * // 重载 1: null / undefined + checkEmpty = true (默认) → ""
+   * StringUtil.cast(null); // ""
+   * StringUtil.cast(undefined); // ""
+   * StringUtil.cast(""); // ""
+   * StringUtil.cast("   "); // ""
+   *
+   * // 重载 2: null / undefined + checkEmpty = false → "null" / "undefined"
+   * StringUtil.cast(null, false); // "null" (类型为 "null")
+   * StringUtil.cast(undefined, false); // "undefined" (类型为 "undefined")
+   *
+   * // 重载 3: 原始类型 → 字符串字面量类型
+   * StringUtil.cast(123); // "123" (类型为 "123")
+   * StringUtil.cast("hello"); // "hello" (类型为 "hello")
+   * StringUtil.cast(true); // "true" (类型为 "true")
+   * StringUtil.cast(42n); // "42" (类型为 "42")
+   *
+   * // 重载 4: 其他类型 → string
+   * StringUtil.cast(Symbol("foo")); // "Symbol(foo)" (类型为 string)
+   * ```
+   */
+  static cast<T extends null | undefined>(candidate: T, checkEmpty?: true): "";
+  static cast<T extends null | undefined>(candidate: T, checkEmpty: false): `${T}`;
+  static cast<T extends string | number | bigint | boolean>(candidate: T, checkEmpty?: boolean): `${T}`;
+  static cast(candidate: unknown, checkEmpty?: boolean): string;
   /**
    * 从字符串中提取数字字符串
    * - 移除非数字字符，保留符号和小数点
@@ -4102,15 +4135,18 @@ declare class TypeUtil {
   private static isConstructable;
   /**
    * 检查 value 是否为 string 类型
+   * - 当 `checkEmpty` 为 `true` 时，会先 trim 再判断是否为空
    *
    * @param value 待检查值
-   * @param checkEmpty 是否检查空字符串
+   * @param checkEmpty 是否检查空字符串（含空白字符串），默认为 `false`
    * @returns 是否为字符串
    * @example
    * ```ts
    * TypeUtil.isString("abc"); // true
    * TypeUtil.isString(""); // true
    * TypeUtil.isString("", true); // false
+   * TypeUtil.isString("   ", true); // false
+   * TypeUtil.isString(" a ", true); // true
    * ```
    */
   static isString(value: unknown, checkEmpty?: boolean): value is string;
@@ -4322,18 +4358,19 @@ declare class TypeUtil {
    *
    * @param value 待检查值
    * @param prototypeCheck 是否进行原型检查，默认 `true`
-   * @returns 是否为 Plain Object (当 checkPrototype=true) 或 object
+   * @returns 是否为 Plain Object (当 prototypeCheck=true) 或 object
    * @example
    * ```ts
-   * TypeUtil.isObject({}); // true
-   * TypeUtil.isObject([]); // false
-   * TypeUtil.isObject(new Date()); // false
-   * TypeUtil.isObject(new Date(), false); // true
-   * TypeUtil.isObject(Object.create(null)) // false
-   * TypeUtil.isObject(Object.create(null), false) // true
+   * TypeUtil.isPlainObject({}); // true
+   * TypeUtil.isPlainObject([]); // false
+   * TypeUtil.isPlainObject(new Date()); // false
+   * TypeUtil.isPlainObject(new (class {})()); // false
+   * TypeUtil.isPlainObject(new (class {})(), false); // true
+   * TypeUtil.isPlainObject(Object.create(null)) // false
+   * TypeUtil.isPlainObject(Object.create(null), false) // true
    * ```
    */
-  static isObject(value: unknown, prototypeCheck?: boolean): value is Record<PropertyKey, unknown>;
+  static isPlainObject(value: unknown, prototypeCheck?: boolean): value is Record<PropertyKey, unknown>;
   /**
    * 判断一个对象是否为有效的枚举
    * - 枚举成员不能为空