@ceale/util 1.20.0 → 1.21.0

package/README.md

@@ -10,7 +10,7 @@
     - removeAllSuffixes()
     - toCamelCase()
     - toKebabCase()
-- Function.prototype
+- namespace: `ClassUtil`
     - isDirectSubclass()
     - isSubclass()
     - isDirectInstance()
@@ -44,11 +44,16 @@
 - `type.ts`
     - assert()
     - expand()
+    - `type` anyobject
+    - `type` AnyClass
+    - `type` RequireOne
+- `enum_v2.ts`:
+    - Enum()
+    - EnumOf<>
+- `enum_v1.ts`
     - defineEnum()
     - Enum()
     - EnumKeys<>
-    - `type` anyobject
-    - `type` AnyClass
 - Object.prototype
     - hasKeys()
     - inKeys()

package/dist/cjs/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ClassUtil: () => ClassUtil,
   CubicBezier: () => CubicBezier,
   Enum: () => Enum2,
   EnumV1: () => enum_v1_exports,
@@ -138,55 +139,38 @@ var uri;
 })(uri || (uri = {}));
 
 // src/class.ts
-Object.defineProperty(Function.prototype, "isDirectSubclass", {
-  value: function(potentialChild) {
-    if (typeof potentialChild !== "function" || typeof this !== "function") {
+var ClassUtil;
+((ClassUtil2) => {
+  ClassUtil2.isDirectSubclass = (parent, potentialChild) => {
+    if (typeof potentialChild !== "function" || typeof parent !== "function") {
       return false;
     }
-    return Object.getPrototypeOf(potentialChild) === this;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
-Object.defineProperty(Function.prototype, "isSubclass", {
-  value: function(potentialDescendant) {
-    if (typeof potentialDescendant !== "function" || typeof this !== "function") {
+    return Object.getPrototypeOf(potentialChild) === parent;
+  };
+  ClassUtil2.isSubclass = (parent, potentialDescendant) => {
+    if (typeof potentialDescendant !== "function" || typeof parent !== "function") {
       return false;
     }
     let current = potentialDescendant;
     while (typeof current === "function") {
-      if (current === this) {
+      if (current === parent) {
         return true;
       }
       current = Object.getPrototypeOf(current);
-      if (current === Function.prototype) break;
+      if (!current || current === Function.prototype) break;
     }
     return false;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
-Object.defineProperty(Function.prototype, "isDirectInstance", {
-  value: function(potentialInstance) {
-    if (typeof this !== "function" || potentialInstance === null || typeof potentialInstance !== "object") {
+  };
+  ClassUtil2.isDirectInstance = (targetClass, potentialInstance) => {
+    if (typeof targetClass !== "function" || potentialInstance === null || typeof potentialInstance !== "object") {
       return false;
     }
-    return Object.getPrototypeOf(potentialInstance).constructor === this;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
-Object.defineProperty(Function.prototype, "isInstance", {
-  value: function(potentialInstance) {
-    return typeof this === "function" && potentialInstance instanceof this;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
+    return Object.getPrototypeOf(potentialInstance)?.constructor === targetClass;
+  };
+  ClassUtil2.isInstance = (targetClass, potentialInstance) => {
+    return typeof targetClass === "function" && potentialInstance instanceof targetClass;
+  };
+})(ClassUtil || (ClassUtil = {}));
 
 // src/css.ts
 var css;

package/dist/esm/index.js

@@ -102,55 +102,38 @@ var uri;
 })(uri || (uri = {}));
 
 // src/class.ts
-Object.defineProperty(Function.prototype, "isDirectSubclass", {
-  value: function(potentialChild) {
-    if (typeof potentialChild !== "function" || typeof this !== "function") {
+var ClassUtil;
+((ClassUtil2) => {
+  ClassUtil2.isDirectSubclass = (parent, potentialChild) => {
+    if (typeof potentialChild !== "function" || typeof parent !== "function") {
       return false;
     }
-    return Object.getPrototypeOf(potentialChild) === this;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
-Object.defineProperty(Function.prototype, "isSubclass", {
-  value: function(potentialDescendant) {
-    if (typeof potentialDescendant !== "function" || typeof this !== "function") {
+    return Object.getPrototypeOf(potentialChild) === parent;
+  };
+  ClassUtil2.isSubclass = (parent, potentialDescendant) => {
+    if (typeof potentialDescendant !== "function" || typeof parent !== "function") {
       return false;
     }
     let current = potentialDescendant;
     while (typeof current === "function") {
-      if (current === this) {
+      if (current === parent) {
         return true;
       }
       current = Object.getPrototypeOf(current);
-      if (current === Function.prototype) break;
+      if (!current || current === Function.prototype) break;
     }
     return false;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
-Object.defineProperty(Function.prototype, "isDirectInstance", {
-  value: function(potentialInstance) {
-    if (typeof this !== "function" || potentialInstance === null || typeof potentialInstance !== "object") {
+  };
+  ClassUtil2.isDirectInstance = (targetClass, potentialInstance) => {
+    if (typeof targetClass !== "function" || potentialInstance === null || typeof potentialInstance !== "object") {
       return false;
     }
-    return Object.getPrototypeOf(potentialInstance).constructor === this;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
-Object.defineProperty(Function.prototype, "isInstance", {
-  value: function(potentialInstance) {
-    return typeof this === "function" && potentialInstance instanceof this;
-  },
-  writable: true,
-  configurable: true,
-  enumerable: false
-});
+    return Object.getPrototypeOf(potentialInstance)?.constructor === targetClass;
+  };
+  ClassUtil2.isInstance = (targetClass, potentialInstance) => {
+    return typeof targetClass === "function" && potentialInstance instanceof targetClass;
+  };
+})(ClassUtil || (ClassUtil = {}));
 
 // src/css.ts
 var css;
@@ -443,6 +426,7 @@ var Enum2 = (...values) => {
   return obj;
 };
 export {
+  ClassUtil,
   CubicBezier,
   Enum2 as Enum,
   enum_v1_exports as EnumV1,

package/dist/types/class.d.ts

@@ -1,32 +1,33 @@
 import type { AnyClass } from "./type";
-declare global {
-    interface Function {
-        /**
-         * 检查 `potentialChild` 是否是当前类的直接子类
-         * @param potentialChild 潜在的子类构造函数
-         * @returns 如果是直接子类，则返回 `true`；否则返回 `false`
-         */
-        isDirectSubclass(this: AnyClass, potentialChild: unknown): boolean;
-        /**
-         * 检查 `potentialDescendant` 是否是当前类的子孙类或当前类本身
-         * @param potentialDescendant 潜在的子孙类或类本身
-         * @returns 如果是子孙类或类本身，则返回 `true`；否则返回 `false`
-         */
-        isSubclass(this: AnyClass, potentialDescendant: unknown): boolean;
-        /**
-         * 检查 `potentialInstance` 是否由当前类直接构造
-         * 判断依据: `Object.getPrototypeOf(potentialInstance).constructor === this`
-         * @param potentialInstance 潜在的实例对象
-         * @returns 如果是由当前类直接创建的实例，则返回 `true`；否则返回 `false`
-         */
-        isDirectInstance(this: AnyClass, potentialInstance: unknown): boolean;
-        /**
-         * 检查 `potentialInstance` 是否是当前类或其任何子类的实例
-         * 内部使用 `instanceof` 操作符
-         * @param potentialInstance 潜在的实例对象
-         * @returns 如果是实例，则返回 `true`；否则返回 `false`
-         */
-        isInstance(this: AnyClass, potentialInstance: unknown): boolean;
-    }
+export declare namespace ClassUtil {
+    /**
+     * 检查 `potentialChild` 是否是当前类的直接子类
+     * @param parent 当前类（父类）
+     * @param potentialChild 潜在的子类构造函数
+     * @returns 如果是直接子类，则返回 `true`；否则返回 `false`
+     */
+    const isDirectSubclass: (parent: AnyClass, potentialChild: unknown) => boolean;
+    /**
+     * 检查 `potentialDescendant` 是否是当前类的子孙类或当前类本身
+     * @param parent 当前类
+     * @param potentialDescendant 潜在的子孙类或类本身
+     * @returns 如果是子孙类或类本身，则返回 `true`；否则返回 `false`
+     */
+    const isSubclass: (parent: AnyClass, potentialDescendant: unknown) => boolean;
+    /**
+     * 检查 `potentialInstance` 是否由当前类直接构造
+     * 判断依据: `Object.getPrototypeOf(potentialInstance).constructor === targetClass`
+     * @param targetClass 当前类
+     * @param potentialInstance 潜在的实例对象
+     * @returns 如果是由当前类直接创建的实例，则返回 `true`；否则返回 `false`
+     */
+    const isDirectInstance: (targetClass: AnyClass, potentialInstance: unknown) => boolean;
+    /**
+     * 检查 `potentialInstance` 是否是当前类或其任何子类的实例
+     * 内部使用 `instanceof` 操作符
+     * @param targetClass 当前类
+     * @param potentialInstance 潜在的实例对象
+     * @returns 如果是实例，则返回 `true`；否则返回 `false`
+     */
+    const isInstance: (targetClass: AnyClass, potentialInstance: unknown) => boolean;
 }
-export {};

package/dist/types/type.d.ts

@@ -22,3 +22,18 @@ export declare const assert: <Type = any>(variable: any) => asserts variable is
  * @returns 传入的变量，且类型被拓展为指定类型
  */
 export declare const expand: <Type>(variable: any) => asserts variable is (typeof variable & Type);
+/**
+ * 强制对象类型中至少包含一个指定的属性。
+ * @example
+ * ```ts
+ * interface User { id: string; name: string; age: number; }
+ * // 有效：包含一个或多个属性
+ * const update: RequireOne<User> = { name: 'Gemini' };
+ * // 错误：不允许空对象
+ * const invalid: RequireOne<User> = {};
+ * ```
+ * @template T - 需要处理的基础对象接口。其中不应有可选属性，有可能会导致未预料的情况。
+ */
+export type RequireOne<T> = {
+    [K in keyof T]: Required<Pick<T, K>> & Partial<Omit<T, K>>;
+}[keyof T];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ceale/util",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "author": "Ceale",
   "description": "小工具集",
   "repository": {