Introduction of JSDoc

.editorconfig

@@ -19,6 +19,6 @@ indent_size = 2
 [*.{json,yml}]
 indent_size = 2
 
-[*.md]
+[*.{js,md,ts,vue}]
 max_line_length = off
 trim_trailing_whitespace = false

eslint.config.mjs

@@ -10,6 +10,7 @@ const gitignorePath = path.resolve(__dirname, ".gitignore");
 
 export default [includeIgnoreFile(gitignorePath), ...eslintTs, {
     rules: {
+        "no-trailing-spaces": ["error", { "ignoreComments": true }],
         "@typescript-eslint/no-non-null-assertion": "off",
         "@typescript-eslint/unified-signatures": "off"
     }

package.json

@@ -36,12 +36,12 @@
   "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"
       }
     }
   },
@@ -58,10 +58,10 @@
   },
   "devDependencies": {
     "@byloth/eslint-config-typescript": "^3.0.3",
-    "@types/node": "^22.10.2",
+    "@types/node": "^22.10.7",
     "husky": "^9.1.7",
-    "typescript": "^5.7.2",
-    "vite": "^5.4.11"
+    "typescript": "^5.7.3",
+    "vite": "^6.0.10"
   },
   "packageManager": "pnpm@9.15.0+sha512.76e2379760a4328ec4415815bcd6628dee727af3779aaa4c914e3944156c4299921a89f976381ee107d41f12cfa4b66681ca9c718f0668fa0831ed4c6d8ba56c"
 }

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>;

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"));

src/index.ts

@@ -40,7 +40,11 @@ export {
 
 export type {
     AsyncGeneratorFunction,
+    AsyncIteratee,
     AsyncIteratorLike,
+    AsyncKeyedIteratee,
+    AsyncKeyedReducer,
+    AsyncReducer,
     Callback,
     FulfilledHandler,
     GeneratorFunction,
@@ -51,22 +55,20 @@ export type {
     JSONValue,
     KeyedIteratee,
     KeyedReducer,
-    KeyedTypeGuardIteratee,
+    KeyedTypeGuardPredicate,
     MaybeAsyncKeyedIteratee,
     MaybeAsyncKeyedReducer,
-    MaybeAsyncKeyedTypeGuardIteratee,
     MaybeAsyncGeneratorFunction,
     MaybeAsyncIteratee,
     MaybeAsyncIteratorLike,
     MaybeAsyncReducer,
-    MaybeAsyncTypeGuardIteratee,
     MaybePromise,
     PromiseExecutor,
     PromiseRejecter,
     PromiseResolver,
     Reducer,
     RejectedHandler,
-    TypeGuardIteratee
+    TypeGuardPredicate
 
 } from "./models/types.js";
 
@@ -82,6 +84,7 @@ export {
     dateRound,
     TimeUnit,
     enumerate,
+    getWeek,
     hash,
     loadScript,
     nextAnimationFrame,
@@ -90,6 +93,7 @@ export {
     shuffle,
     sum,
     unique,
+    WeekDay,
     yieldToEventLoop,
     zip