@ceale/util 1.14.1 → 1.15.0

package/README.md

@@ -43,4 +43,7 @@
     - tryCatch()
 - `type.ts`
     - assert()
-    - defineEnum()
+    - expand()
+    - defineEnum()
+    - Enum()
+    - EnumKeys<>

package/dist/cjs/index.js

@@ -37,12 +37,14 @@ __export(exports_src, {
   sleepAsync: () => sleepAsync,
   sleep: () => sleep,
   quadraticCurve: () => quadraticCurve,
+  expand: () => expand,
   defineEnum: () => defineEnum,
   debounce: () => debounce,
   cubicCurve: () => cubicCurve,
   css: () => css,
   assert: () => assert,
   QuadraticBezier: () => QuadraticBezier,
+  Enum: () => Enum,
   CubicBezier: () => CubicBezier
 });
 module.exports = __toCommonJS(exports_src);
@@ -422,10 +424,13 @@ var tryCatch = (parameter) => {
   throw new TypeError("参数类型错误，应为 Promise 或函数");
 };
 // src/type.ts
-var assert = (variable) => {};
-var defineEnum = (...keys) => {
-  return keys.reduce((acc, key) => {
-    acc[key] = key;
-    return acc;
-  }, {});
-};
+var assert = (variable) => variable;
+var expand = (variable) => variable;
+var defineEnum = (...keys) => keys.reduce((acc, key) => {
+  acc[key] = key;
+  return acc;
+}, {});
+var Enum = (keys) => ({
+  keys: () => Object.keys(keys),
+  includes: (key) => Object.keys(keys).includes(key)
+});

package/dist/esm/index.js

@@ -373,13 +373,16 @@ var tryCatch = (parameter) => {
   throw new TypeError("参数类型错误，应为 Promise 或函数");
 };
 // src/type.ts
-var assert = (variable) => {};
-var defineEnum = (...keys) => {
-  return keys.reduce((acc, key) => {
-    acc[key] = key;
-    return acc;
-  }, {});
-};
+var assert = (variable) => variable;
+var expand = (variable) => variable;
+var defineEnum = (...keys) => keys.reduce((acc, key) => {
+  acc[key] = key;
+  return acc;
+}, {});
+var Enum = (keys) => ({
+  keys: () => Object.keys(keys),
+  includes: (key) => Object.keys(keys).includes(key)
+});
 export {
   waitSync,
   wait,
@@ -389,11 +392,13 @@ export {
   sleepAsync,
   sleep,
   quadraticCurve,
+  expand,
   defineEnum,
   debounce,
   cubicCurve,
   css,
   assert,
   QuadraticBezier,
+  Enum,
   CubicBezier
 };

package/dist/types/type.d.ts

@@ -2,8 +2,16 @@
  * 就地断言一个变量为指定类型
  * @template Type 断言的类型，默认为`any`
  * @param variable 待断言的变量
+ * @returns 传入的变量，且类型已经被断言为指定类型
  */
 export declare const assert: <Type = any>(variable: any) => asserts variable is Type;
+/**
+ * 拓展一个变量的类型
+ * @param variable 待拓展的变量
+ * @param Type 拓展的类型
+ * @returns 传入的变量，且类型被拓展为指定类型
+ */
+export declare const expand: <Type>(variable: any) => asserts variable is (typeof variable & Type);
 /**
  * 定义一个枚举类型。
  * 返回一个枚举对象，其中每个键名与值相同。
@@ -18,3 +26,32 @@ export declare const assert: <Type = any>(variable: any) => asserts variable is
  * }
  */
 export declare const defineEnum: <T extends string>(...keys: T[]) => { [K in T]: K; };
+/**
+ * 枚举工具函数，为枚举对象提供工具方法
+ * @param keys 由 defineEnum 创建的枚举对象
+ * @returns 返回一个包含`keys`、`includes`方法的对象
+ *
+ * @example
+ * const 对吗 = defineEnum("对", "不对")
+ *
+ * // 获取所有枚举键
+ * Enum(对吗).keys() // ["对", "不对"]
+ *
+ * // 检查值是否为有效枚举值
+ * Enum(对吗).includes("对") // true
+ * Enum(对吗).includes("错") // false
+ */
+export declare const Enum: (keys: Record<string, string>) => {
+    keys: () => (keyof typeof keys)[];
+    includes: (key: any) => boolean;
+};
+/**
+ * 提取枚举的所有键组成联合类型
+ * @template E 由 defineEnum 创建的枚举对象
+ * @returns 枚举键的联合类型
+ *
+ * @example
+ * const 对吗 = defineEnum("对", "不对")
+ * Enum<typeof 对吗> // "对" | "不对"
+ */
+export type EnumKeys<E> = E[keyof E];

package/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@ceale/util",
   "author": "Ceale",
-  "version": "1.14.1",
+  "description": "小工具集",
+  "license": "Unlicense or CC0 or WTFPL",
+  "version": "1.15.0",
   "module": "index.ts",
   "type": "module",
   "main": "dist/esm/index.js",