extra-utils 5.4.0 → 5.5.1

package/README.md

@@ -191,8 +191,24 @@ removeTrailingBlankLines(
 
 ### Enum
 ```ts
-function inEnum<T>(val: unknown, _enum: object): val is T
-function notInEnum<T, U>(val: T, _enum: object): val is Exclude<T, U>
+function inEnum<T extends Record<string, string | number>>(
+  val: string | number
+, _enum: T
+): val is T[keyof T]
+function notInEnum(
+  val: string | number
+, _enum: Record<string, string | number>
+): boolean
+
+function enumKeys<T extends Record<string, string | number>>(
+  _enum: T
+): Array<keyof T>
+function enumValues<T extends Record<string, string | number>>(
+  _enum: T
+): Array<T[keyof T]>
+function enumEntries<T extends Record<string, string | number>>(
+  _enum: T
+): Array<{ [Key in keyof T]: [Key, T[Key]] }[keyof T]>
 ```
 
 ### Date

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

@@ -0,0 +1,3 @@
+export declare function enumEntries<T extends Record<string, string | number>>(_enum: T): Array<{
+    [Key in keyof T]: [Key, T[Key]];
+}[keyof T]>;

package/lib/enum/enum-entries.js

@@ -0,0 +1,5 @@
+import { enumKeys } from './enum-keys.js';
+export function enumEntries(_enum) {
+    return enumKeys(_enum).map(key => [key, _enum[key]]);
+}
+//# sourceMappingURL=enum-entries.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enum-entries.js","sourceRoot":"","sources":["../../src/enum/enum-entries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,MAAM,UAAU,WAAW,CACzB,KAAQ;IAER,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AACtD,CAAC"}

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

@@ -0,0 +1 @@
+export declare function enumKeys<T extends Record<string, string | number>>(_enum: T): Array<keyof T>;

package/lib/enum/enum-keys.js

@@ -0,0 +1,5 @@
+export function enumKeys(_enum) {
+    return Object.keys(_enum)
+        .filter(key => Number.isNaN(Number(key)));
+}
+//# sourceMappingURL=enum-keys.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enum-keys.js","sourceRoot":"","sources":["../../src/enum/enum-keys.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,QAAQ,CACtB,KAAQ;IAER,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;SACtB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAC7C,CAAC"}

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

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

package/lib/enum/enum-values.js

@@ -0,0 +1,6 @@
+import { enumKeys } from './enum-keys.js';
+export function enumValues(_enum) {
+    const keys = enumKeys(_enum);
+    return keys.map(key => _enum[key]);
+}
+//# sourceMappingURL=enum-values.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enum-values.js","sourceRoot":"","sources":["../../src/enum/enum-values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,MAAM,UAAU,UAAU,CACxB,KAAQ;IAER,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AACpC,CAAC"}

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

@@ -0,0 +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;

package/lib/enum/in-enum.js

@@ -0,0 +1,8 @@
+import { enumValues } from './enum-values.js';
+export function inEnum(val, _enum) {
+    return enumValues(_enum).includes(val);
+}
+export function notInEnum(val, _enum) {
+    return !inEnum(val, _enum);
+}
+//# sourceMappingURL=in-enum.js.map

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

@@ -0,0 +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"}

package/lib/enum/index.d.ts

@@ -0,0 +1,4 @@
+export * from './in-enum.js';
+export * from './enum-keys.js';
+export * from './enum-values.js';
+export * from './enum-entries.js';

package/lib/enum/index.js

@@ -0,0 +1,5 @@
+export * from './in-enum.js';
+export * from './enum-keys.js';
+export * from './enum-values.js';
+export * from './enum-entries.js';
+//# sourceMappingURL=index.js.map

package/lib/enum/index.js.map

@@ -0,0 +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"}

package/lib/index.d.ts

@@ -6,7 +6,7 @@ export * from './object/index.js';
 export * from './json/index.js';
 export * from './string/index.js';
 export * from './nullish/index.js';
-export * from './in-enum.js';
+export * from './enum/index.js';
 export * from './is-regexp.js';
 export * from './is-symbol.js';
 export * from './is-date.js';

package/lib/index.js

@@ -6,7 +6,7 @@ export * from './object/index.js';
 export * from './json/index.js';
 export * from './string/index.js';
 export * from './nullish/index.js';
-export * from './in-enum.js';
+export * from './enum/index.js';
 export * from './is-regexp.js';
 export * from './is-symbol.js';
 export * from './is-date.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,kBAAkB,CAAA;AAChC,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-utils",
-  "version": "5.4.0",
+  "version": "5.5.1",
   "description": "Utilities for JavaScript and Typescript",
   "files": [
     "src",
@@ -34,32 +34,32 @@
     }
   },
   "devDependencies": {
-    "@blackglory/jest-resolver": "^0.3.1",
-    "@blackglory/pass": "^1.1.1",
-    "@commitlint/cli": "^17.6.7",
-    "@commitlint/config-conventional": "^17.6.7",
-    "@types/jest": "^29.5.3",
+    "@blackglory/jest-resolver": "^0.3.0",
+    "@blackglory/pass": "^1.1.0",
+    "@commitlint/cli": "^17.6.1",
+    "@commitlint/config-conventional": "^17.6.1",
+    "@types/jest": "^29.5.0",
     "@types/jsdom": "^21.1.1",
-    "@types/lodash-es": "^4.17.8",
-    "@typescript-eslint/eslint-plugin": "^6.1.0",
-    "@typescript-eslint/parser": "^6.1.0",
+    "@types/lodash-es": "^4.17.7",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.45.0",
+    "eslint": "^8.38.0",
     "husky": "^4.3.8",
-    "jest": "^29.6.1",
-    "jest-resolve": "^29.6.1",
+    "jest": "^29.5.0",
+    "jest-resolve": "^29.5.0",
     "npm-run-all": "^4.1.5",
-    "rimraf": "^5.0.1",
+    "rimraf": "^3.0.2",
     "standard-version": "^9.5.0",
-    "ts-jest": "^29.1.1",
-    "ts-patch": "^3.0.2",
+    "ts-jest": "^29.1.0",
+    "ts-patch": "^2.1.0",
     "tsd": "^0.28.1",
-    "tslib": "^2.6.0",
-    "typescript": "5.1.6",
+    "tslib": "^2.5.0",
+    "typescript": "4.8",
     "typescript-transform-paths": "^3.4.6"
   },
   "dependencies": {
-    "justypes": "^4.2.1",
+    "justypes": "^4.2.0",
     "lodash-es": "^4.17.21"
   }
 }

package/src/enum/enum-entries.ts

@@ -0,0 +1,7 @@
+import { enumKeys } from './enum-keys.js'
+
+export function enumEntries<T extends Record<string, string | number>>(
+  _enum: T
+): Array<{ [Key in keyof T]: [Key, T[Key]] }[keyof T]> {
+  return enumKeys(_enum).map(key => [key, _enum[key]])
+}

package/src/enum/enum-keys.ts

@@ -0,0 +1,6 @@
+export function enumKeys<T extends Record<string, string | number>>(
+  _enum: T
+): Array<keyof T> {
+  return Object.keys(_enum)
+    .filter(key => Number.isNaN(Number(key))) // TypeScript枚举不能以数值为键
+}

package/src/enum/enum-values.ts

@@ -0,0 +1,8 @@
+import { enumKeys } from './enum-keys.js'
+
+export function enumValues<T extends Record<string, string | number>>(
+  _enum: T
+): Array<T[keyof T]> {
+  const keys = enumKeys(_enum)
+  return keys.map(key => _enum[key])
+}

package/src/enum/in-enum.ts

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

package/src/enum/index.ts

@@ -0,0 +1,4 @@
+export * from './in-enum.js'
+export * from './enum-keys.js'
+export * from './enum-values.js'
+export * from './enum-entries.js'

package/src/index.ts

@@ -6,7 +6,7 @@ export * from './object/index.js'
 export * from './json/index.js'
 export * from './string/index.js'
 export * from './nullish/index.js'
-export * from './in-enum.js'
+export * from './enum/index.js'
 export * from './is-regexp.js'
 export * from './is-symbol.js'
 export * from './is-date.js'

package/lib/in-enum.d.ts

@@ -1,2 +0,0 @@
-export declare function inEnum<T>(val: unknown, _enum: object): val is T;
-export declare function notInEnum<T, U>(val: T, _enum: object): val is Exclude<T, U>;

package/lib/in-enum.js

@@ -1,7 +0,0 @@
-export function inEnum(val, _enum) {
-    return Object.values(_enum).includes(val);
-}
-export function notInEnum(val, _enum) {
-    return !inEnum(val, _enum);
-}
-//# sourceMappingURL=in-enum.js.map

package/lib/in-enum.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"in-enum.js","sourceRoot":"","sources":["../src/in-enum.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,MAAM,CAAI,GAAY,EAAE,KAAa;IACnD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,SAAS,CAAO,GAAM,EAAE,KAAa;IACnD,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AAC5B,CAAC"}

package/src/in-enum.ts

@@ -1,10 +0,0 @@
-// 由于以下原因, 该函数不应该被改写为其他形式:
-// - enum在TypeScript里被作为单独的类型看待, 不满足extends object
-// - 作为泛型时, enum参数会被提取为typeof enum类型而不是enum
-export function inEnum<T>(val: unknown, _enum: object): val is T {
-  return Object.values(_enum).includes(val)
-}
-
-export function notInEnum<T, U>(val: T, _enum: object): val is Exclude<T, U> {
-  return !inEnum(val, _enum)
-}