Merge branch 'release/v3.1.1-beta.0'

.eslintrc.cjs

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 // eslint-disable-next-line import/no-commonjs, import/unambiguous
 module.exports = {
     env: {

README.md

@@ -343,7 +343,8 @@ export type { Calculator };
 
 ```ts
 // ./src/createCalculatorWorker.ts
-import { ObjectInfo, implementObjectWorkerExternal, Worker } from "kiss-worker";
+import { ObjectInfo, implementObjectWorkerExternal, Worker } from
+    "kiss-worker";
 
 // Import the type only
 import type { Calculator } from "./Calculator.ts";

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kiss-worker",
-  "version": "3.1.0",
+  "version": "3.1.1-beta.0",
   "description": "Provides one of the easiest ways to use a worker thread.",
   "keywords": [
     "kiss",
@@ -54,24 +54,24 @@
     "finish-release": "git flow release finish -p -m \"chore: finish release\" v`cat package.json | jq -r '.version'`"
   },
   "devDependencies": {
-    "@andreashuber69/eslint-config": "^1.2.19",
-    "@tsconfig/node-lts": "^20.1.3",
+    "@andreashuber69/eslint-config": "^1.2.30",
+    "@tsconfig/node-lts": "^22.0.1",
     "@tsconfig/strictest": "^2.0.5",
-    "@types/node": "^20.12.13",
-    "@vitest/browser": "^1.5.0",
-    "@vitest/coverage-istanbul": "^1.5.0",
+    "@types/node": "^22.10.1",
+    "@vitest/browser": "^2.1.8",
+    "@vitest/coverage-istanbul": "^2.1.8",
     "api": "file:src/api",
-    "c8": "^9.1.0",
+    "c8": "^10.1.2",
     "coveralls": "^3.1.1",
-    "cspell": "^8.8.3",
-    "markdownlint-cli": "^0.41.0",
-    "tsx": "^4.11.0",
-    "typedoc": "^0.25.13",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.12",
-    "vite-plugin-dts": "^3.9.1",
-    "vitest": "^1.5.0",
-    "webdriverio": "^8.38.0"
+    "cspell": "^8.16.1",
+    "markdownlint-cli": "^0.43.0",
+    "tsx": "^4.19.2",
+    "typedoc": "^0.27.3",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.3",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "^2.1.8",
+    "webdriverio": "^9.4.1"
   },
   "peerDependencies": {
     "tsx": "^4.11.0"

src/DedicatedWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { implementFunctionWorker } from "./implementFunctionWorker.ts";
 import type { implementFunctionWorkerExternal } from "./implementFunctionWorkerExternal.ts";
 import type { implementObjectWorker } from "./implementObjectWorker.ts";

src/FunctionInfo.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { implementFunctionWorkerExternal } from "./implementFunctionWorkerExternal.ts";
 import type { serveFunction } from "./serveFunction.ts";
 

src/FunctionWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { implementFunctionWorker } from "./implementFunctionWorker.ts";
 import type { implementFunctionWorkerExternal } from "./implementFunctionWorkerExternal.ts";
 

src/FunctionWorkerImpl.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { DedicatedWorker } from "./DedicatedWorker.ts";
 import { PromiseQueue } from "./PromiseQueue.ts";
 import { getCause, isInvalidWorkerFile } from "api";

src/MethodsOnlyObject.ts

@@ -1,6 +1,8 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 /**
  * Constrains `T` to only declare methods.
+ * @template T The type of the object to be constrained to containing only methods.
  * @description The primary purpose of a worker is to provide a way to offload CPU-bound work onto a separate thread.
  * The interface of a type supporting such a use case often looks quite different from one that runs code that does not
  * hog the CPU. While the latter might have a well balanced mixture of fields, getters, setters and (mutating) methods,

src/ObjectInfo.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { implementObjectWorkerExternal } from "./implementObjectWorkerExternal.ts";
 import type { MethodsOnlyObject } from "./MethodsOnlyObject.ts";
 import type { serveObject } from "./serveObject.ts";

src/ObjectWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { implementObjectWorker } from "./implementObjectWorker.ts";
 import type { implementObjectWorkerExternal } from "./implementObjectWorkerExternal.ts";
 import type { MethodsOnlyObject } from "./MethodsOnlyObject.ts";

src/ObjectWorkerImpl.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { DedicatedWorker } from "./DedicatedWorker.ts";
 import { FunctionInfo } from "./FunctionInfo.ts";
 import type { FunctionWorker } from "./FunctionWorker.ts";
@@ -17,9 +18,9 @@ class ProxyImpl<C extends new (..._: never[]) => T, T extends MethodsOnlyObject<
         this.#worker = worker;
 
         for (const key of propertyNames) {
-            // The cast-fest below is necessary because there seems to be no way to transform the type of args to the
-            // parameter types of #worker.execute. The same goes for the type of the function.
             this[key as string] = (async (...args: Parameters<Proxy<T>[keyof Proxy<T>]>) =>
+                // The cast-fest below is necessary because there seems to be no way to transform the type of args to
+                // the parameter types of #worker.execute. The same goes for the type of the function.
                 await this.#worker.execute(...(["call", key, ...args] as Parameters<CallSignature<T>>))
             ) as Proxy<T>[keyof Proxy<T>];
         }

src/PromiseQueue.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { describe, expect, it } from "vitest";
 
 import { PromiseQueue } from "./PromiseQueue.ts";

src/PromiseQueue.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 export class PromiseQueue {
     public async execute<T>(createAwaitable: () => Promise<T>) {
         const resultPromise = PromiseQueue.push(this.pendingPromise, createAwaitable);

src/Proxy.ts

@@ -1,8 +1,10 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { MethodsOnlyObject } from "./MethodsOnlyObject.ts";
 
 /**
  * A type with async equivalents of the methods declared on `T`.
+ * @template T The original type.
  * @description Contains only the methods with string identifiers, methods identified by numbers or symbols will not
  * appear.
  */

src/Worker.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { describe, it } from "vitest";
 import { Worker } from "./index.ts";
 

src/api/TsxWorker.js

@@ -1,3 +1,5 @@
+// https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { workerData } from "node:worker_threads";
 // This is an optional peer dependency. If the worker script does not end in "ts", this script is never executed.
 // eslint-disable-next-line import/no-extraneous-dependencies

src/api/browserApi.ts

@@ -1,3 +1,5 @@
+// https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 const addEventListenerLocal = addEventListener;
 const postMessageLocal = postMessage;
 const WorkerLocal = Worker;

src/api/nodeApi.ts

@@ -1,14 +1,14 @@
+// https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { WorkerOptions } from "node:worker_threads";
 import { isMainThread, parentPort, Worker } from "node:worker_threads";
 
-const addEventListener = (type: "message", listener: (ev: MessageEvent) => unknown): void =>
-    void parentPort?.addListener(
-        type,
-        // Code coverage is not reported for code executed within a worker, because only the original (uninstrumented)
-        // version of the code is ever loaded.
-        /* istanbul ignore next -- @preserve */
-        (value: unknown) => listener({ data: value } as unknown as MessageEvent),
-    );
+const addEventListener = (type: "message", listener: (ev: MessageEvent) => unknown) => {
+    // Code coverage is not reported for code executed within a worker, because only the original (uninstrumented)
+    // version of the code is ever loaded.
+    /* istanbul ignore next -- @preserve */
+    parentPort?.addListener(type, (value: unknown) => listener({ data: value } as unknown as MessageEvent));
+};
 
 const isWorker = () => !isMainThread;
 

src/getAllPropertyNames.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { describe, expect, it } from "vitest";
 
 import { getAllPropertyNames } from "./getAllPropertyNames.ts";

src/getAllPropertyNames.ts

@@ -1,3 +1,5 @@
+// https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 const getAllPropertyNamesImpl = (obj: unknown): string[] => {
     if (obj && obj !== Object.prototype) {
         return [

src/implementFunctionWorker.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { assert, describe, expect, it } from "vitest";
 import { createDelayWorker } from "./testHelpers/createDelayWorker.ts";
 import { createFibonacciWorker } from "./testHelpers/createFibonacciWorker.ts";
@@ -92,7 +93,7 @@ describe("FunctionWorker", () => {
             try {
                 await worker.execute(() => 2);
             } catch (error: unknown) {
-                expect(error instanceof Error && error.message.endsWith("() => 2 could not be cloned.")).toBe(true);
+                expect(error instanceof Error && error.message.endsWith("could not be cloned.")).toBe(true);
             }
         });
 

src/implementFunctionWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { DedicatedWorker } from "./DedicatedWorker.ts";
 import { FunctionInfo } from "./FunctionInfo.ts";
 import type { FunctionWorker } from "./FunctionWorker.ts";

src/implementFunctionWorkerExternal.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { describe, expect, it } from "vitest";
 import { createFibonacciWorkerExternal } from "./testHelpers/createFibonacciWorkerExternal.ts";
 

src/implementFunctionWorkerExternal.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { DedicatedWorker } from "./DedicatedWorker.ts";
 import type { FunctionInfo } from "./FunctionInfo.ts";
 import type { FunctionWorker } from "./FunctionWorker.ts";

src/implementObjectWorker.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { describe, expect, it } from "vitest";
 import { createCalculatorWorker } from "./testHelpers/createCalculatorWorker.ts";
 import { createMisbehavedWorker } from "./testHelpers/createMisbehavedWorker.ts";

src/implementObjectWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { DedicatedWorker } from "./DedicatedWorker.ts";
 import { implementObjectWorkerExternal } from "./implementObjectWorkerExternal.ts";
 import type { MethodsOnlyObject } from "./MethodsOnlyObject.ts";

src/implementObjectWorkerExternal.spec.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { describe, expect, it } from "vitest";
 import { createCalculatorWorkerExternal } from "./testHelpers/createCalculatorWorkerExternal.ts";
 

src/implementObjectWorkerExternal.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { DedicatedWorker } from "./DedicatedWorker.ts";
 import type { implementObjectWorker } from "./implementObjectWorker.ts";
 import type { MethodsOnlyObject } from "./MethodsOnlyObject.ts";

src/serveFunction.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import type { implementFunctionWorkerExternal } from "./implementFunctionWorkerExternal.ts";
 import { addEventListener, postMessage } from "api";
 

src/serveObject.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { getAllPropertyNames } from "./getAllPropertyNames.ts";
 import type { implementObjectWorkerExternal } from "./implementObjectWorkerExternal.ts";
 import type { MethodsOnlyObject } from "./MethodsOnlyObject.ts";

src/testHelpers/Calculator.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { serveObject } from "../index.ts";
 
 class Calculator {

src/testHelpers/bounce.js

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 const bounce = (/** @type {unknown} */ x) => x;
 
 export { bounce };

src/testHelpers/createCalculatorWorker.ts

@@ -1,4 +1,6 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+/* eslint-disable jsdoc/convert-to-jsdoc-comments */
+
 import { implementObjectWorker, Worker } from "../index.ts";
 
 // We want to serve an object of this class on a worker thread

src/testHelpers/createCalculatorWorkerExternal.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementObjectWorkerExternal, ObjectInfo, Worker } from "../index.ts";
 import type { Calculator } from "./Calculator.ts";
 

src/testHelpers/createDelayWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementFunctionWorker, Worker } from "../index.ts";
 
 export const createDelayWorker = implementFunctionWorker(

src/testHelpers/createFibonacciWorker.ts

@@ -1,4 +1,6 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+/* eslint-disable jsdoc/convert-to-jsdoc-comments */
+
 import { implementFunctionWorker, Worker } from "../index.ts";
 
 // The function we want to execute on a worker thread

src/testHelpers/createFibonacciWorkerExternal.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { FunctionInfo, implementFunctionWorkerExternal, Worker } from "../index.ts";
 import type { fibonacciExternal } from "./fibonacciExternal.ts";
 

src/testHelpers/createFunnyWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementFunctionWorker, Worker } from "../index.ts";
 import { postMessage } from "api";
 

src/testHelpers/createMisbehavedWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementObjectWorker, Worker } from "../index.ts";
 
 class Bouncer {

src/testHelpers/createThrowingWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementObjectWorker, Worker } from "../index.ts";
 
 class Throwing {

src/testHelpers/createUniversalFunctionWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementFunctionWorker, Worker } from "../index.ts";
 
 export const createUniversalFunctionWorker = implementFunctionWorker(

src/testHelpers/createUniversalObjectWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementFunctionWorker, Worker } from "../index.ts";
 
 export interface Obj {

src/testHelpers/createWrongFilenameWorker.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { implementFunctionWorker, Worker } from "../index.ts";
 
 export const createWrongFilenameWorker =

src/testHelpers/fibonacciExternal.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { serveFunction } from "../index.ts";
 
 const fibonacciExternal = (n: number): number =>

vite.browser.config.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { defineConfig } from "vite";
 import dts from "vite-plugin-dts";
 

vite.node.config.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { defineConfig } from "vite";
 
 // eslint-disable-next-line import/no-default-export, import/no-anonymous-default-export

vitest.config.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { defineConfig } from "vitest/config";
 
 // eslint-disable-next-line import/no-anonymous-default-export, import/no-default-export
@@ -7,7 +8,7 @@ export default defineConfig({
         coverage: {
             provider: "istanbul",
             include: ["src/**/*.ts"],
-            exclude: ["src/testHelpers/*.ts"],
+            exclude: ["src/testHelpers/*.ts", "src/**/*.spec.ts"],
             reporter: ["lcov", "text"],
         },
     },

vitest.workspace.ts

@@ -1,4 +1,5 @@
 // https://github.com/andreashuber69/kiss-worker/blob/develop/README.md
+
 import { defineWorkspace } from "vitest/config";
 
 // eslint-disable-next-line import/no-anonymous-default-export, import/no-default-export
@@ -7,6 +8,7 @@ export default defineWorkspace([
         test: {
             name: "browser",
             browser: {
+                provider: "webdriverio",
                 enabled: true,
                 name: "chrome",
             },