extra-utils 5.5.1 → 5.6.0

package/README.md

@@ -192,11 +192,11 @@ removeTrailingBlankLines(
 ### Enum
 ```ts
 function inEnum<T extends Record<string, string | number>>(
-  val: string | number
+  val: unknown
 , _enum: T
 ): val is T[keyof T]
 function notInEnum(
-  val: string | number
+  val: unknown
 , _enum: Record<string, string | number>
 ): boolean
 
@@ -209,6 +209,11 @@ function enumValues<T extends Record<string, string | number>>(
 function enumEntries<T extends Record<string, string | number>>(
   _enum: T
 ): Array<{ [Key in keyof T]: [Key, T[Key]] }[keyof T]>
+
+function getEnumKey<T extends Record<string, string | number>>(
+  _enum: T
+, enumValue: T[keyof T]
+): keyof T
 ```
 
 ### Date

package/lib/enum/get-enum-key.d.ts

@@ -0,0 +1 @@
+export declare function getEnumKey<T extends Record<string, string | number>>(_enum: T, enumValue: T[keyof T]): keyof T;

package/lib/enum/get-enum-key.js

@@ -0,0 +1,10 @@
+import { enumEntries } from './enum-entries.js';
+export function getEnumKey(_enum, enumValue) {
+    for (const [key, value] of enumEntries(_enum)) {
+        if (value === enumValue) {
+            return key;
+        }
+    }
+    throw new Error('There are no enumeration items matching the given value.');
+}
+//# sourceMappingURL=get-enum-key.js.map

package/lib/enum/get-enum-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-enum-key.js","sourceRoot":"","sources":["../../src/enum/get-enum-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,UAAU,UAAU,CACxB,KAAQ,EACR,SAAqB;IAErB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,GAAG,CAAA;SACX;KACF;IAED,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;AAC7E,CAAC"}

package/lib/enum/in-enum.d.ts

@@ -1,2 +1,2 @@
-export declare function inEnum<T extends Record<string, string | number>>(val: string | number, _enum: T): val is T[keyof T];
-export declare function notInEnum(val: string | number, _enum: Record<string, string | number>): boolean;
+export declare function inEnum<T extends Record<string, string | number>>(val: unknown, _enum: T): val is T[keyof T];
+export declare function notInEnum(val: unknown, _enum: Record<string, string | number>): boolean;

package/lib/enum/in-enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"in-enum.js","sourceRoot":"","sources":["../../src/enum/in-enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,MAAM,UAAU,MAAM,CACpB,GAAoB,EACpB,KAAQ;IAER,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAiB,CAAC,CAAA;AACtD,CAAC;AAGD,MAAM,UAAU,SAAS,CACvB,GAAoB,EACpB,KAAsC;IAEtC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AAC5B,CAAC"}
+{"version":3,"file":"in-enum.js","sourceRoot":"","sources":["../../src/enum/in-enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,MAAM,UAAU,MAAM,CACpB,GAAY,EACZ,KAAQ;IAER,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAiB,CAAC,CAAA;AACtD,CAAC;AAGD,MAAM,UAAU,SAAS,CACvB,GAAY,EACZ,KAAsC;IAEtC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AAC5B,CAAC"}

package/lib/enum/index.d.ts

@@ -2,3 +2,4 @@ export * from './in-enum.js';
 export * from './enum-keys.js';
 export * from './enum-values.js';
 export * from './enum-entries.js';
+export * from './get-enum-key.js';

package/lib/enum/index.js

@@ -2,4 +2,5 @@ export * from './in-enum.js';
 export * from './enum-keys.js';
 export * from './enum-values.js';
 export * from './enum-entries.js';
+export * from './get-enum-key.js';
 //# sourceMappingURL=index.js.map

package/lib/enum/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enum/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enum/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-utils",
-  "version": "5.5.1",
+  "version": "5.6.0",
   "description": "Utilities for JavaScript and Typescript",
   "files": [
     "src",

package/src/enum/get-enum-key.ts

@@ -0,0 +1,14 @@
+import { enumEntries } from './enum-entries.js'
+
+export function getEnumKey<T extends Record<string, string | number>>(
+  _enum: T
+, enumValue: T[keyof T]
+): keyof T {
+  for (const [key, value] of enumEntries(_enum)) {
+    if (value === enumValue) {
+      return key
+    }
+  }
+
+  throw new Error('There are no enumeration items matching the given value.')
+}

package/src/enum/in-enum.ts

@@ -1,7 +1,7 @@
 import { enumValues } from './enum-values.js'
 
 export function inEnum<T extends Record<string, string | number>>(
-  val: string | number
+  val: unknown
 , _enum: T
 ): val is T[keyof T] {
   return enumValues(_enum).includes(val as T[keyof T])
@@ -9,7 +9,7 @@ export function inEnum<T extends Record<string, string | number>>(
 
 // 由于TypeScript无法从string | number里精确排除掉枚举类型, 因此返回值为boolean.
 export function notInEnum(
-  val: string | number
+  val: unknown
 , _enum: Record<string, string | number>
 ): boolean {
   return !inEnum(val, _enum)

package/src/enum/index.ts

@@ -2,3 +2,4 @@ export * from './in-enum.js'
 export * from './enum-keys.js'
 export * from './enum-values.js'
 export * from './enum-entries.js'
+export * from './get-enum-key.js'