chore: Improve types (#25)

Author: webJose

src/index.ts

@@ -12,30 +12,3 @@ export * from './workers/AsyncWorker.js';
 export * from "./workers/workerListener.js";
 export * from './workers/WorkerTerminatedMessage.js';
 export * from "./workers/WorkItem.js";
-
-/**
- * Token primitive type.
- */
-export type Token = Int32Array;
-
-/**
- * Helper type that enables proper inference of payload and return types.
- * 
- * Used by the async workers to provide proper Intellisense.
- */
-export type WorkerTasks<T extends Record<string, (...args: any) => any>> = {
-    [K in keyof T]: {
-        payload: Parameters<T[K]>[0];
-        return: ReturnType<T[K]>;
-    }
-};
-
-/**
- * Message sent to a worker.
- */
-export type AsyncMessage<Tasks extends Record<string, (...args: any) => any>> = {
-    task: keyof Tasks;
-    workItemId: number;
-    cancelToken?: Token;
-    payload?: WorkerTasks<Tasks>[keyof Tasks]['payload'];
-};

src/workers.d.ts

@@ -19,7 +19,17 @@ export type WorkerTasks<T extends Record<string, (...args: any) => any>> = {
 /**
  * Message sent to a worker.
  */
-export type AsyncMessage = {
+export type AsyncMessage<Tasks extends Record<string, (...args: any) => any>> = {
+    task: keyof Tasks;
+    workItemId: number;
+    cancelToken?: Token;
+    payload?: WorkerTasks<Tasks>[keyof Tasks]['payload'];
+};
+
+/**
+ * Message sent to a worker.
+ */
+export type AsyncMessageUntyped = {
     workItemId: number;
     task: string;
     cancelToken?: Token;
@@ -58,7 +68,7 @@ export type QueueingOptions = {
 
 export interface IWorker {
     connect(id: number, processMessage: ProcessMessageFn, resolve: (data: any) => void, reject: (reason: any) => void): DisconnectFn | undefined;
-    post(message: AsyncMessage, transferables: Transferable[] | undefined): void;
+    post(message: AsyncMessageUntyped, transferables: Transferable[] | undefined): void;
     terminate(): boolean;
 }
 

src/workers/InternalSharedWorker.ts

@@ -1,5 +1,5 @@
 import { CancelledMessage } from "../cancellation/CancelledMessage.js";
-import type { AsyncMessage, AsyncResponse, DisconnectFn, IWorker, ProcessMessageFn, RejectFn, TaskCancelledMessage } from "../workers.js";
+import type { AsyncMessageUntyped, AsyncResponse, DisconnectFn, IWorker, ProcessMessageFn, RejectFn, TaskCancelledMessage } from "../workers.js";
 
 function isTaskCancelledMessage(message: any): message is TaskCancelledMessage {
     return message?.payload?._$cancelled === true && typeof message.workItemId === 'number';
@@ -50,7 +50,7 @@ export class InternalSharedWorker implements IWorker {
         };
     }
 
-    post(message: AsyncMessage, transferables: Transferable[] | undefined): void {
+    post(message: AsyncMessageUntyped, transferables: Transferable[] | undefined): void {
         this.#worker.port.postMessage(message, { transfer: transferables });
     }
 

src/workers/InternalWorker.ts

@@ -1,5 +1,5 @@
 import { CancelledMessage } from "../cancellation/CancelledMessage.js";
-import type { AsyncMessage, AsyncResponse, DisconnectFn, IWorker, ProcessMessageFn, RejectFn, TaskCancelledMessage } from "../workers.js";
+import type { AsyncMessageUntyped, AsyncResponse, DisconnectFn, IWorker, ProcessMessageFn, RejectFn, TaskCancelledMessage } from "../workers.js";
 import { WorkerTerminatedMessage } from "./WorkerTerminatedMessage.js";
 
 function isTaskCancelledMessage(message: any): message is TaskCancelledMessage {
@@ -51,7 +51,7 @@ export class InternalWorker implements IWorker {
         };
     }
 
-    post(message: AsyncMessage, transferables: Transferable[] | undefined): void {
+    post(message: AsyncMessageUntyped, transferables: Transferable[] | undefined): void {
         if (this.#terminated) {
             throw new Error('The worker has been terminated and cannot accept new messages.');
         }

src/workers/WorkItemInternal.ts

@@ -1,8 +1,8 @@
 import { CancellationSource } from "../cancellation/CancellationSource.js";
 import { CancelledMessage } from "../cancellation/CancelledMessage.js";
-import type { AsyncMessage, DisconnectFn, IWorker, QueueingOptions, WorkItemData } from "../workers.js";
+import type { AsyncMessageUntyped, DisconnectFn, IWorker, QueueingOptions, WorkItemData } from "../workers.js";
 import { WorkItemStatus, type WorkItemStatusEnum } from "./AsyncWorker.js";
-import { WorkerTerminatedMessage } from "./WorkerTerminatedMessage";
+import { WorkerTerminatedMessage } from "./WorkerTerminatedMessage.js";
 
 export class WorkItemInternal<TResult = any> {
     worker;
@@ -13,7 +13,7 @@ export class WorkItemInternal<TResult = any> {
     status: WorkItemStatusEnum;
     disconnect: DisconnectFn | undefined;
 
-    constructor(worker: IWorker, data: WorkItemData<TResult>, options: QueueingOptions | undefined) {
+    constructor(worker: IWorker, data: WorkItemData<TResult>, options?: QueueingOptions | undefined) {
         this.status = WorkItemStatus.Enqueued;
         this.cancelled = false;
         this.worker = worker;
@@ -57,7 +57,7 @@ export class WorkItemInternal<TResult = any> {
             return;
         }
         this.status = WorkItemStatus.Started;
-        const wiPayload: AsyncMessage = {
+        const wiPayload: AsyncMessageUntyped = {
             workItemId: this.data.id,
             task: this.data.task,
             cancelToken: this.cancellationSource?.token,

src/workers/workerListener.ts

@@ -1,12 +1,12 @@
 import { TaskCancelledError } from "../cancellation/TaskCancelledError.js";
-import { AsyncMessage, AsyncResponse } from "../workers.js";
+import type { AsyncMessageUntyped, AsyncResponse } from "../workers.d.ts";
 
 /**
  * Defines the function provided to worker tasks so workers can communicate back to the calling thread.
  */
 export type PostFn = (payload: any, options?: WindowPostMessageOptions) => void;
 
-function isAsyncMessage(msg: any): msg is AsyncMessage {
+function isAsyncMessage(msg: any): msg is AsyncMessageUntyped {
     return typeof msg.workItemId === 'number' && msg.task && typeof msg.task === 'string';
 }
 
@@ -24,7 +24,7 @@ function post(workItemId: number, payload: any, options?: WindowPostMessageOptio
  * @returns The sought listener.
  */
 export function workerListener<Tasks extends Record<string, (...args: any) => any>>(workerTasks: Tasks) {
-    return (ev: MessageEvent<AsyncMessage>) => {
+    return (ev: MessageEvent<AsyncMessageUntyped>) => {
         if (!isAsyncMessage(ev.data)) {
             return;
         }