extra-utils 5.5.2 → 5.7.0

package/README.md

@@ -72,6 +72,11 @@ function isntNaN(val: number): boolean
 
 function isBigInt(val: unknown): val is bigint
 function isntBigInt<T>(val: T): val is Exclude<T, bigint>
+
+function clamp(
+  val: number
+, [min, max]: [min: number, max: number]
+): number
 ```
 
 ### Object
@@ -209,6 +214,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/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/lib/number/clamp.d.ts

@@ -0,0 +1 @@
+export declare function clamp(val: number, [min, max]: [min: number, max: number]): number;

package/lib/number/clamp.js

@@ -0,0 +1,4 @@
+export function clamp(val, [min, max]) {
+    return Math.max(min, Math.min(val, max));
+}
+//# sourceMappingURL=clamp.js.map

package/lib/number/clamp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clamp.js","sourceRoot":"","sources":["../../src/number/clamp.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,KAAK,CACnB,GAAW,EACX,CAAC,GAAG,EAAE,GAAG,CAA6B;IAEtC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;AAC1C,CAAC"}

package/lib/number/index.d.ts

@@ -3,3 +3,4 @@ export * from './is-finite.js';
 export * from './is-infinity.js';
 export * from './is-nan.js';
 export * from './is-number.js';
+export * from './clamp.js';

package/lib/number/index.js

@@ -3,4 +3,5 @@ export * from './is-finite.js';
 export * from './is-infinity.js';
 export * from './is-nan.js';
 export * from './is-number.js';
+export * from './clamp.js';
 //# sourceMappingURL=index.js.map

package/lib/number/index.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-utils",
-  "version": "5.5.2",
+  "version": "5.7.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/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'

package/src/number/clamp.ts

@@ -0,0 +1,6 @@
+export function clamp(
+  val: number
+, [min, max]: [min: number, max: number]
+): number {
+  return Math.max(min, Math.min(val, max))
+}

package/src/number/index.ts

@@ -3,3 +3,4 @@ export * from './is-finite.js'
 export * from './is-infinity.js'
 export * from './is-nan.js'
 export * from './is-number.js'
+export * from './clamp.js'