@jiaozi-dev/kit 0.0.1 → 0.0.3

package/README.md

@@ -24,22 +24,44 @@ pnpm add @jiaozi-dev/kit
 ## Enum
 
 ```typescript
-import { Enum } from "@jiaozi-dev/kit";
+import { Enum, getEnumKeys, getEnumValues, getEnumEntries, hasEnumKey, getEnumValue } from "@jiaozi-dev/kit";
 
 const STATUS = Enum({
     Success: "success",
     Warning: "warning",
     Error: "error",
 });
+// inferred as
+// const STATUS: Readonly<{
+//     readonly Success: "success";
+//     readonly Warning: "warning";
+//     readonly Error: "error";
+// }>;
+
 type STATUS = Enum<typeof STATUS>;
+// inferred as
+// type STATUS = "success" | "warning" | "error";
+
+getEnumKeys(STATUS);
+// inferred as
+// Readonly<["Success", "Warning", "Error"]>
+
+getEnumValues(STATUS);
+// inferred as
+// Readonly<["success", "warning", "error"]>
+
+getEnumEntries(STATUS);
+// inferred as
+// Readonly<[["Success", "success"], ["Warning", "warning"], ["Error", "error"]]>
+
+hasEnumKey(STATUS, "Success");
+// inferred as
+// true
 
+STATUS.Success;
+getEnumValue(STATUS, "Success");
 // inferred as
-const STATUS: Readonly<{
-    readonly Success: "success";
-    readonly Warning: "warning";
-    readonly Error: "error";
-}>;
-type STATUS = "success" | "warning" | "error";
+// "success"
 ```
 
 ## ...

package/dist/index.cjs

@@ -1,2 +1,2 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});function e(e){return Object.freeze(e)}exports.Enum=e;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});function e(e){return Object.freeze(e)}function t(e){return Object.freeze(Object.keys(e))}function n(e){return Object.freeze(Object.values(e))}function r(e){return Object.freeze(Object.entries(e))}function i(e,t){return t in e}function a(e,t){return e[t]}exports.Enum=e,exports.getEnumEntries=r,exports.getEnumKeys=t,exports.getEnumValue=a,exports.getEnumValues=n,exports.hasEnumKey=i;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":[],"sources":["../src/enum/Enum.ts"],"sourcesContent":["/**\r\n * @example\r\n * ```typescript\r\n    const STATUS = Enum({\r\n        Success: \"success\",\r\n        Warning: \"warning\",\r\n        Error: \"error\",\r\n    });\r\n    type STATUS = Enum<typeof STATUS>;\r\n    ```\r\n */\r\nexport function Enum<const T extends object>(object: T): Readonly<T> {\r\n    return Object.freeze(object);\r\n}\r\n\r\nexport type Enum<T extends object> = T[keyof T];\r\n"],"mappings":"mEAWA,SAAgB,EAA6B,EAAwB,CACjE,OAAO,OAAO,OAAO,EAAO"}
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/enum/Enum.ts"],"sourcesContent":["//\r\ntype EnumKey = string;\r\ntype EnumValue = any;\r\ntype EnumObject = Record<EnumKey, EnumValue>;\r\n\r\n//\r\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\r\ntype LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never;\r\ntype UnionToTuple<T, L = LastOf<T>> = [T] extends [never] ? [] : [...UnionToTuple<Exclude<T, L>>, L];\r\n\r\n//\r\ntype EntriesToTuple<T extends EnumObject, U extends keyof T = keyof T> = [U] extends [never]\r\n    ? []\r\n    : LastOf<U> extends infer L extends keyof T\r\n      ? [...EntriesToTuple<T, Exclude<U, L>>, readonly [L, T[L]]]\r\n      : [];\r\n\r\n//\r\nexport function Enum<const T extends EnumObject>(enumObject: T): Readonly<T> {\r\n    return Object.freeze(enumObject);\r\n}\r\n\r\nexport type Enum<T extends EnumObject> = T[keyof T];\r\n\r\n//\r\nexport function getEnumKeys<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<keyof T>> {\r\n    return Object.freeze(Object.keys(enumObject)) as unknown as Readonly<UnionToTuple<keyof T>>;\r\n}\r\n\r\nexport function getEnumValues<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<T[keyof T]>> {\r\n    return Object.freeze(Object.values(enumObject)) as unknown as Readonly<UnionToTuple<T[keyof T]>>;\r\n}\r\n\r\nexport function getEnumEntries<const T extends EnumObject>(enumObject: T): Readonly<EntriesToTuple<T>> {\r\n    return Object.freeze(Object.entries(enumObject)) as unknown as Readonly<EntriesToTuple<T>>;\r\n}\r\n\r\n//\r\nexport function hasEnumKey<const T extends EnumObject, const K extends EnumKey>(\r\n    enumObject: T,\r\n    key: K\r\n): key is K & keyof T {\r\n    return key in enumObject;\r\n}\r\n\r\nexport function getEnumValue<const T extends EnumObject, K extends keyof T>(enumObject: T, key: K): T[K] {\r\n    return enumObject[key];\r\n}\r\n"],"mappings":"mEAkBA,SAAgB,EAAiC,EAA4B,CACzE,OAAO,OAAO,OAAO,EAAW,CAMpC,SAAgB,EAAwC,EAAgD,CACpG,OAAO,OAAO,OAAO,OAAO,KAAK,EAAW,CAAC,CAGjD,SAAgB,EAA0C,EAAmD,CACzG,OAAO,OAAO,OAAO,OAAO,OAAO,EAAW,CAAC,CAGnD,SAAgB,EAA2C,EAA4C,CACnG,OAAO,OAAO,OAAO,OAAO,QAAQ,EAAW,CAAC,CAIpD,SAAgB,EACZ,EACA,EACkB,CAClB,OAAO,KAAO,EAGlB,SAAgB,EAA4D,EAAe,EAAc,CACrG,OAAO,EAAW"}

package/dist/index.d.cts

@@ -1,17 +1,18 @@
 //#region src/enum/Enum.d.ts
-/**
- * @example
- * ```typescript
-    const STATUS = Enum({
-        Success: "success",
-        Warning: "warning",
-        Error: "error",
-    });
-    type STATUS = Enum<typeof STATUS>;
-    ```
- */
-declare function Enum<const T extends object>(object: T): Readonly<T>;
-type Enum<T extends object> = T[keyof T];
+type EnumKey = string;
+type EnumValue = any;
+type EnumObject = Record<EnumKey, EnumValue>;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends (() => infer R) ? R : never;
+type UnionToTuple<T, L = LastOf<T>> = [T] extends [never] ? [] : [...UnionToTuple<Exclude<T, L>>, L];
+type EntriesToTuple<T extends EnumObject, U extends keyof T = keyof T> = [U] extends [never] ? [] : LastOf<U> extends infer L extends keyof T ? [...EntriesToTuple<T, Exclude<U, L>>, readonly [L, T[L]]] : [];
+declare function Enum<const T extends EnumObject>(enumObject: T): Readonly<T>;
+type Enum<T extends EnumObject> = T[keyof T];
+declare function getEnumKeys<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<keyof T>>;
+declare function getEnumValues<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<T[keyof T]>>;
+declare function getEnumEntries<const T extends EnumObject>(enumObject: T): Readonly<EntriesToTuple<T>>;
+declare function hasEnumKey<const T extends EnumObject, const K extends EnumKey>(enumObject: T, key: K): key is K & keyof T;
+declare function getEnumValue<const T extends EnumObject, K extends keyof T>(enumObject: T, key: K): T[K];
 //#endregion
-export { Enum };
+export { Enum, getEnumEntries, getEnumKeys, getEnumValue, getEnumValues, hasEnumKey };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,17 +1,18 @@
 //#region src/enum/Enum.d.ts
-/**
- * @example
- * ```typescript
-    const STATUS = Enum({
-        Success: "success",
-        Warning: "warning",
-        Error: "error",
-    });
-    type STATUS = Enum<typeof STATUS>;
-    ```
- */
-declare function Enum<const T extends object>(object: T): Readonly<T>;
-type Enum<T extends object> = T[keyof T];
+type EnumKey = string;
+type EnumValue = any;
+type EnumObject = Record<EnumKey, EnumValue>;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends (() => infer R) ? R : never;
+type UnionToTuple<T, L = LastOf<T>> = [T] extends [never] ? [] : [...UnionToTuple<Exclude<T, L>>, L];
+type EntriesToTuple<T extends EnumObject, U extends keyof T = keyof T> = [U] extends [never] ? [] : LastOf<U> extends infer L extends keyof T ? [...EntriesToTuple<T, Exclude<U, L>>, readonly [L, T[L]]] : [];
+declare function Enum<const T extends EnumObject>(enumObject: T): Readonly<T>;
+type Enum<T extends EnumObject> = T[keyof T];
+declare function getEnumKeys<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<keyof T>>;
+declare function getEnumValues<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<T[keyof T]>>;
+declare function getEnumEntries<const T extends EnumObject>(enumObject: T): Readonly<EntriesToTuple<T>>;
+declare function hasEnumKey<const T extends EnumObject, const K extends EnumKey>(enumObject: T, key: K): key is K & keyof T;
+declare function getEnumValue<const T extends EnumObject, K extends keyof T>(enumObject: T, key: K): T[K];
 //#endregion
-export { Enum };
+export { Enum, getEnumEntries, getEnumKeys, getEnumValue, getEnumValues, hasEnumKey };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,2 +1,2 @@
-function e(e){return Object.freeze(e)}export{e as Enum};
+function e(e){return Object.freeze(e)}function t(e){return Object.freeze(Object.keys(e))}function n(e){return Object.freeze(Object.values(e))}function r(e){return Object.freeze(Object.entries(e))}function i(e,t){return t in e}function a(e,t){return e[t]}export{e as Enum,r as getEnumEntries,t as getEnumKeys,a as getEnumValue,n as getEnumValues,i as hasEnumKey};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/enum/Enum.ts"],"sourcesContent":["/**\r\n * @example\r\n * ```typescript\r\n    const STATUS = Enum({\r\n        Success: \"success\",\r\n        Warning: \"warning\",\r\n        Error: \"error\",\r\n    });\r\n    type STATUS = Enum<typeof STATUS>;\r\n    ```\r\n */\r\nexport function Enum<const T extends object>(object: T): Readonly<T> {\r\n    return Object.freeze(object);\r\n}\r\n\r\nexport type Enum<T extends object> = T[keyof T];\r\n"],"mappings":"AAWA,SAAgB,EAA6B,EAAwB,CACjE,OAAO,OAAO,OAAO,EAAO"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/enum/Enum.ts"],"sourcesContent":["//\r\ntype EnumKey = string;\r\ntype EnumValue = any;\r\ntype EnumObject = Record<EnumKey, EnumValue>;\r\n\r\n//\r\ntype UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;\r\ntype LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never;\r\ntype UnionToTuple<T, L = LastOf<T>> = [T] extends [never] ? [] : [...UnionToTuple<Exclude<T, L>>, L];\r\n\r\n//\r\ntype EntriesToTuple<T extends EnumObject, U extends keyof T = keyof T> = [U] extends [never]\r\n    ? []\r\n    : LastOf<U> extends infer L extends keyof T\r\n      ? [...EntriesToTuple<T, Exclude<U, L>>, readonly [L, T[L]]]\r\n      : [];\r\n\r\n//\r\nexport function Enum<const T extends EnumObject>(enumObject: T): Readonly<T> {\r\n    return Object.freeze(enumObject);\r\n}\r\n\r\nexport type Enum<T extends EnumObject> = T[keyof T];\r\n\r\n//\r\nexport function getEnumKeys<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<keyof T>> {\r\n    return Object.freeze(Object.keys(enumObject)) as unknown as Readonly<UnionToTuple<keyof T>>;\r\n}\r\n\r\nexport function getEnumValues<const T extends EnumObject>(enumObject: T): Readonly<UnionToTuple<T[keyof T]>> {\r\n    return Object.freeze(Object.values(enumObject)) as unknown as Readonly<UnionToTuple<T[keyof T]>>;\r\n}\r\n\r\nexport function getEnumEntries<const T extends EnumObject>(enumObject: T): Readonly<EntriesToTuple<T>> {\r\n    return Object.freeze(Object.entries(enumObject)) as unknown as Readonly<EntriesToTuple<T>>;\r\n}\r\n\r\n//\r\nexport function hasEnumKey<const T extends EnumObject, const K extends EnumKey>(\r\n    enumObject: T,\r\n    key: K\r\n): key is K & keyof T {\r\n    return key in enumObject;\r\n}\r\n\r\nexport function getEnumValue<const T extends EnumObject, K extends keyof T>(enumObject: T, key: K): T[K] {\r\n    return enumObject[key];\r\n}\r\n"],"mappings":"AAkBA,SAAgB,EAAiC,EAA4B,CACzE,OAAO,OAAO,OAAO,EAAW,CAMpC,SAAgB,EAAwC,EAAgD,CACpG,OAAO,OAAO,OAAO,OAAO,KAAK,EAAW,CAAC,CAGjD,SAAgB,EAA0C,EAAmD,CACzG,OAAO,OAAO,OAAO,OAAO,OAAO,EAAW,CAAC,CAGnD,SAAgB,EAA2C,EAA4C,CACnG,OAAO,OAAO,OAAO,OAAO,QAAQ,EAAW,CAAC,CAIpD,SAAgB,EACZ,EACA,EACkB,CAClB,OAAO,KAAO,EAGlB,SAAgB,EAA4D,EAAe,EAAc,CACrG,OAAO,EAAW"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jiaozi-dev/kit",
-    "version": "0.0.1",
+    "version": "0.0.3",
     "description": "A modern, type-safe TypeScript utility kit.",
     "type": "module",
     "main": "./dist/index.cjs",