ts-enum-next 1.0.3 → 1.0.4

package/README.md

@@ -2,25 +2,27 @@
 
 <b>English | <a href="./README.zh-CN.md">中文</a></b>
 
+A TypeScript library that helps with the enum pattern.
+
 - The ultimate solution for next-generation enumeration in TypeScript
 
 - Define and use enum in typescript like using enum in java.
 
-## Why？ 
+## Why？
 
 It is very convenient to use enum to define numeric enums and string enums in typescript, but when you are defining some enums of numeric dictionary types, you are a little overwhelmed. For example, when we define a set of states, we need to define the name of the state at the same time. We can combine enumerations and mapping objects in typescript to implement it.
 
 ```ts
 enum Status {
-    PENDING = 0,
-    APPROVED = 1,
-    REJECTED = 2
+  PENDING = 0,
+  APPROVED = 1,
+  REJECTED = 2,
 }
 
 const StatusDescriptions = {
-    [Status.PENDING]: "waiting",
-    [Status.APPROVED]: "Approved",
-    [Status.REJECTED]: "reject"
+  [Status.PENDING]: "waiting",
+  [Status.APPROVED]: "Approved",
+  [Status.REJECTED]: "reject",
 };
 
 console.log(Status.PENDING); // 0
@@ -40,17 +42,22 @@ pnpm add ts-enum-next
 ```
 
 ### Define data dictionary
+
 ```ts
 class HttpStatus extends Enum<number> {
-	static readonly OK = new HttpStatus(200, 'OK', 'Request succeeded');
-	static readonly BAD_REQUEST = new HttpStatus(400, 'BAD_REQUEST', 'Error request');
-	static readonly NOT_FOUND = new HttpStatus(404, 'NOT_FOUND');
+  static readonly OK = new HttpStatus(200, "OK", "Request succeeded");
+  static readonly BAD_REQUEST = new HttpStatus(
+    400,
+    "BAD_REQUEST",
+    "Error request"
+  );
+  static readonly NOT_FOUND = new HttpStatus(404, "NOT_FOUND");
 }
 ```
 
 ### Using a data dictionary
 
-* Get dictionary items
+- Get dictionary items
 
 ```ts
 console.log(HttpStatus.OK.description); // "Request succeeded"
@@ -58,32 +65,31 @@ console.log(HttpStatus.fromValue(404).name); // "NOT_FOUND"
 console.log(HttpStatus.fromName("BAD_REQUEST").value); // 400
 ```
 
-* Get all enum values
+- Get all enum values
 
 ```ts
 const allStatuses = HttpStatus.values();
-console.log(allStatuses.map(s => s.name)); // ["OK", "BAD_REQUEST", "NOT_FOUND"]
+console.log(allStatuses.map((s) => s.name)); // ["OK", "BAD_REQUEST", "NOT_FOUND"]
 ```
 
-* Using enumeration collection
+- Using enumeration collection
 
 ```ts
 const errorStatuses = HttpStatus.setOf(
-    HttpStatus.BAD_REQUEST,
-    HttpStatus.NOT_FOUND
+  HttpStatus.BAD_REQUEST,
+  HttpStatus.NOT_FOUND
 );
 console.log(errorStatuses.has(HttpStatus.fromValue(400))); // true
 ```
 
-* Using enumeration map
+- Using enumeration map
 
 ```ts
 const statusMessages = HttpStatus.enumMap({
-    [HttpStatus.OK.value]: "Operation is successful",
-    [HttpStatus.BAD_REQUEST.value]: "Request error",
-    "NOT_FOUND": "The resource does not exist" 
+  [HttpStatus.OK.value]: "Operation is successful",
+  [HttpStatus.BAD_REQUEST.value]: "Request error",
+  NOT_FOUND: "The resource does not exist",
 });
 console.log(statusMessages.get(HttpStatus.NOT_FOUND)); // "The resource does not exist"
-``
-
-
+``;
+```

package/dist/index.d.ts

@@ -2,11 +2,18 @@ type EnumValueType = number | string;
 declare abstract class Enum<T extends string | number = string | number> {
     readonly value: T;
     readonly name: string;
-    readonly description?: string | undefined;
+    /**
+     * @description 附加说明
+     */
+    readonly description?: unknown | undefined;
     private static _values;
     private static _valueMap;
     private static _nameMap;
-    constructor(value: T, name: string, description?: string | undefined);
+    constructor(value: T, name: string, 
+    /**
+     * @description 附加说明
+     */
+    description?: unknown | undefined);
     static values<T extends Enum>(): T[];
     static fromValue<T extends Enum>(this: any, value: T['value']): T;
     static fromName<T extends Enum>(this: any, name: string): T;

package/dist/index.js

@@ -1,5 +1,9 @@
 class Enum {
-    constructor(value, name, description) {
+    constructor(value, name, 
+    /**
+     * @description 附加说明
+     */
+    description) {
         this.value = value;
         this.name = name;
         this.description = description;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-enum-next",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Ultimate Enum Enhancement for TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",