@byloth/core 2.0.0 → 2.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -31,8 +31,8 @@
     "dist",
     "src"
   ],
-  "main": "./dist/core.umd.cjs",
-  "module": "./dist/core.js",
+  "main": "dist/core.umd.cjs",
+  "module": "dist/core.js",
   "exports": {
     ".": {
       "import": {
@@ -45,16 +45,18 @@
       }
     }
   },
-  "types": "./src/index.ts",
+  "types": "src/index.ts",
   "devDependencies": {
     "@byloth/eslint-config-typescript": "^3.1.0",
-    "@eslint/compat": "^1.2.6",
-    "@types/node": "^22.13.0",
+    "@eslint/compat": "^1.2.8",
+    "@types/node": "^22.14.1",
+    "@vitest/coverage-v8": "^3.1.1",
+    "eslint": "^9.25.0",
     "husky": "^9.1.7",
-    "jsdom": "^26.0.0",
-    "typescript": "^5.7.3",
-    "vite": "^6.0.11",
-    "vitest": "^3.0.4"
+    "jsdom": "^26.1.0",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.2",
+    "vitest": "^3.1.1"
   },
   "scripts": {
     "dev": "vite",
@@ -63,6 +65,7 @@
     "typecheck": "tsc",
     "lint": "eslint .",
     "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "ci": "pnpm install --frozen-lockfile"
   }
 }

package/src/core/types.ts

@@ -1,7 +1,10 @@
 /**
- * A utility type that allows to define a class constructor of a specific type.  
- * Is the counterpart of the native `InstanceType` utility type.
+ * An utility type that allows to define a class constructor of a specific type.  
+ * Is the counterpart of the native {@link InstanceType} utility type.
  *
+ * ---
+ *
+ * @example
  * ```ts
  * function factory<T extends object>(Factory: Constructor<T>): T { [...] }
  *
@@ -12,14 +15,17 @@
 export type Constructor<T extends object, P extends unknown[] = any[]> = new (...args: P) => T;
 
 /**
- * A type that represents the return value of `setInterval` function,
+ * A type that represents the return value of {@link setInterval} function,
  * indipendently from the platform it's currently running on.
  *
- * For instance, in a browser environment, it's a `number` value representing the interval ID.  
- * In a Node.js environment, on the other hand, it's an object of type `NodeJS.Timeout`.
+ * For instance, in a browser environment, it's a {@link Number} value representing the interval ID.  
+ * In a Node.js environment, on the other hand, it's an object of type {@link NodeJS.Timeout}.
+ *
+ * This allows to seamlessly use the same code in both environments, without having to deal with the differences.
  *
- * This allows to seamlessly use the same code in both environments, without having to deal with the differences:
+ * ---
  *
+ * @example
  * ```ts
  * const intervalId: Interval = setInterval(() => { [...] }, 1_000);
  *
@@ -29,14 +35,17 @@ export type Constructor<T extends object, P extends unknown[] = any[]> = new (..
 export type Interval = ReturnType<typeof setInterval>;
 
 /**
- * A type that represents the return value of `setTimeout` function,
+ * A type that represents the return value of {@link setTimeout} function,
  * indipendently from the platform it's currently running on.
  *
- * For instance, in a browser environment, it's a `number` value representing the timeout ID.  
- * In a Node.js environment, on the other hand, it's an object of type `NodeJS.Timeout`.
+ * For instance, in a browser environment, it's a {@link Number} value representing the timeout ID.  
+ * In a Node.js environment, on the other hand, it's an object of type {@link NodeJS.Timeout}.
  *
- * This allows to seamlessly use the same code in both environments, without having to deal with the differences:
+ * This allows to seamlessly use the same code in both environments, without having to deal with the differences.
  *
+ * ---
+ *
+ * @example
  * ```ts
  * const timeoutId: Timeout = setTimeout(() => { [...] }, 1_000);
  *
@@ -44,3 +53,27 @@ export type Interval = ReturnType<typeof setInterval>;
  * ```
  */
 export type Timeout = ReturnType<typeof setTimeout>;
+
+/**
+ * An utility type that allows to extract the union of the values of a given type.
+ * It can be used to extract the values of all the properties of an object type.
+ *
+ * ---
+ *
+ * @example
+ * ```ts
+ * class MyObject
+ * {
+ *     protected secret = "Sssh! That's a secret!";
+ *     public answer = 42;
+ *     public greet() { console.log("Hello, world!"); }
+ * }
+ *
+ * type MyObjectProperties = ValueOf<MyObject>;  // number | (() => void)
+ * ```
+ *
+ * ---
+ *
+ * @template T The type to extract the values from.
+ */
+export type ValueOf<T> = T[keyof T];

package/src/index.ts

@@ -1,6 +1,6 @@
-export const VERSION = "2.0.0";
+export const VERSION = "2.0.2";
 
-export type { Constructor, Interval, Timeout } from "./core/types.js";
+export type { Constructor, Interval, Timeout, ValueOf } from "./core/types.js";
 
 export { isBrowser, isNode, isWorker } from "./helpers.js";
 
@@ -47,6 +47,7 @@ export type {
     AsyncKeyedReducer,
     AsyncReducer,
     Callback,
+    CallbackMap,
     FulfilledHandler,
     GeneratorFunction,
     Iteratee,