@byloth/core 2.0.0-rc.9 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.0.0-rc.9",
+  "version": "2.0.1",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -31,27 +31,31 @@
     "dist",
     "src"
   ],
-  "main": "./dist/core.umd.cjs",
-  "module": "./dist/core.js",
+  "main": "dist/core.umd.cjs",
+  "module": "dist/core.js",
   "exports": {
     ".": {
       "import": {
-        "default": "./dist/core.js",
-        "types": "./src/index.ts"
+        "types": "./src/index.ts",
+        "default": "./dist/core.js"
       },
       "require": {
-        "default": "./dist/core.umd.cjs",
-        "types": "./src/index.ts"
+        "types": "./src/index.ts",
+        "default": "./dist/core.umd.cjs"
       }
     }
   },
-  "types": "./src/index.ts",
+  "types": "src/index.ts",
   "devDependencies": {
-    "@byloth/eslint-config-typescript": "^3.0.3",
-    "@types/node": "^22.10.1",
+    "@byloth/eslint-config-typescript": "^3.1.0",
+    "@eslint/compat": "^1.2.7",
+    "@types/node": "^22.13.11",
+    "eslint": "^9.23.0",
     "husky": "^9.1.7",
-    "typescript": "^5.7.2",
-    "vite": "^5.4.11"
+    "jsdom": "^26.0.0",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.2",
+    "vitest": "^3.0.9"
   },
   "scripts": {
     "dev": "vite",
@@ -59,7 +63,7 @@
     "preview": "vite preview",
     "typecheck": "tsc",
     "lint": "eslint .",
-    "test": "vitest",
+    "test": "vitest run",
     "ci": "pnpm install --frozen-lockfile"
   }
 }

package/src/core/types.ts

@@ -1,5 +1,46 @@
+/**
+ * A utility type that allows to define a class constructor of a specific type.  
+ * Is the counterpart of the native `InstanceType` utility type.
+ *
+ * ```ts
+ * function factory<T extends object>(Factory: Constructor<T>): T { [...] }
+ *
+ * const instance: MyObject = factory(MyObject);
+ * ```
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Constructor<T extends object, P extends unknown[] = any[]> = new (...args: P) => T;
 
+/**
+ * A type that represents the return value of `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`.
+ *
+ * This allows to seamlessly use the same code in both environments, without having to deal with the differences:
+ *
+ * ```ts
+ * const intervalId: Interval = setInterval(() => { [...] }, 1_000);
+ *
+ * clearInterval(intervalId);
+ * ```
+ */
 export type Interval = ReturnType<typeof setInterval>;
+
+/**
+ * A type that represents the return value of `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`.
+ *
+ * This allows to seamlessly use the same code in both environments, without having to deal with the differences:
+ *
+ * ```ts
+ * const timeoutId: Timeout = setTimeout(() => { [...] }, 1_000);
+ *
+ * clearTimeout(timeoutId);
+ * ```
+ */
 export type Timeout = ReturnType<typeof setTimeout>;

package/src/helpers.ts

@@ -1,10 +1,19 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 
+/**
+ * An utility constant that indicates whether the current environment is a browser.
+ */
 // @ts-ignore
 export const isBrowser = ((typeof window !== "undefined") && (typeof window.document !== "undefined"));
 
+/**
+ * An utility constant that indicates whether the current environment is a Node.js runtime.
+ */
 // @ts-ignore
-export const isNode = ((typeof process !== "undefined") && (process.versions?.node));
+export const isNode = ((typeof process !== "undefined") && !!(process.versions?.node));
 
+/**
+ * An utility constant that indicates whether the current environment is a Web Worker.
+ */
 // @ts-ignore
-export const isWebWorker = ((typeof self === "object") && (self.constructor?.name === "DedicatedWorkerGlobalScope"));
+export const isWorker = ((typeof self === "object") && (self.constructor?.name === "DedicatedWorkerGlobalScope"));

package/src/index.ts

@@ -1,8 +1,8 @@
-export const VERSION = "2.0.0-rc.9";
+export const VERSION = "2.0.1";
 
 export type { Constructor, Interval, Timeout } from "./core/types.js";
 
-export { isBrowser, isNode, isWebWorker } from "./helpers.js";
+export { isBrowser, isNode, isWorker } from "./helpers.js";
 
 export {
     AggregatedIterator,
@@ -11,6 +11,7 @@ export {
     Clock,
     Countdown,
     DeferredPromise,
+    EnvironmentException,
     Exception,
     FatalErrorException,
     FileException,
@@ -19,7 +20,6 @@ export {
     GameLoop,
     JSONStorage,
     KeyException,
-    LongRunningTask,
     NotImplementedException,
     NetworkException,
     PermissionException,
@@ -32,7 +32,6 @@ export {
     SmartAsyncIterator,
     SmartPromise,
     SwitchableCallback,
-    Thenable,
     TimeoutException,
     TimedPromise,
     TypeException,
@@ -42,7 +41,11 @@ export {
 
 export type {
     AsyncGeneratorFunction,
+    AsyncIteratee,
     AsyncIteratorLike,
+    AsyncKeyedIteratee,
+    AsyncKeyedReducer,
+    AsyncReducer,
     Callback,
     FulfilledHandler,
     GeneratorFunction,
@@ -53,23 +56,20 @@ export type {
     JSONValue,
     KeyedIteratee,
     KeyedReducer,
-    KeyedTypeGuardIteratee,
-    LongRunningTaskOptions,
+    KeyedTypeGuardPredicate,
     MaybeAsyncKeyedIteratee,
     MaybeAsyncKeyedReducer,
-    MaybeAsyncKeyedTypeGuardIteratee,
     MaybeAsyncGeneratorFunction,
     MaybeAsyncIteratee,
     MaybeAsyncIteratorLike,
     MaybeAsyncReducer,
-    MaybeAsyncTypeGuardIteratee,
     MaybePromise,
     PromiseExecutor,
     PromiseRejecter,
     PromiseResolver,
     Reducer,
     RejectedHandler,
-    TypeGuardIteratee
+    TypeGuardPredicate
 
 } from "./models/types.js";
 
@@ -78,12 +78,14 @@ export {
     capitalize,
     chain,
     count,
+    Curve,
     delay,
     dateDifference,
     dateRange,
     dateRound,
     TimeUnit,
     enumerate,
+    getWeek,
     hash,
     loadScript,
     nextAnimationFrame,
@@ -92,6 +94,7 @@ export {
     shuffle,
     sum,
     unique,
+    WeekDay,
     yieldToEventLoop,
     zip