wip: expanded docs

Author: tegefaulkes

src/WorkerManager.ts

@@ -6,7 +6,6 @@ import { type WorkerTaskInformation } from './types.js';
 import * as errors from './errors.js';
 import WorkerPool from './WorkerPool.js';
 
-// TODO: events
 @CreateDestroy()
 class WorkerManager<Manifest extends WorkerManifest> {
   /**
@@ -17,7 +16,7 @@ class WorkerManager<Manifest extends WorkerManifest> {
    * @param options.manifest - The manifest defining the worker capabilities and operations.
    * @param [options.cores=1] - The number of cores to allocate for workers. Defaults to 1.
    * @param [options.logger=new Logger(this.name)] - An optional logger instance for logging activities. Defaults to a new logger.
-   * @return {Promise<WorkerManager<Manifest>>} A promise that resolves to a new WorkerManager instance.
+   * @return A promise that resolves to a new WorkerManager instance.
    */
   public static async createWorkerManager<Manifest extends WorkerManifest>({
     workerFactory,

src/worker.ts

@@ -5,12 +5,21 @@ import { expose } from './expose.js';
  * This is an example worker script used purely for example and internal testing
  */
 const worker = {
+  /**
+   * A test function that returns the string 'hello world!'.
+   */
   test: async (): Promise<{ data: 'hello world!' }> => {
     return { data: 'hello world!' };
   },
+  /**
+   * Adds two parameters `a` and `b` together.
+   */
   add: async (data: { a: number; b: number }) => {
     return { data: data.a + data.b };
   },
+  /**
+   * Subtracts two parameters `a` and `b` together.
+   */
   sub: async (data: { a: number; b: number }) => {
     return { data: data.a - data.b };
   },
@@ -21,6 +30,10 @@ const worker = {
     }
     return { data: acc };
   },
+  /**
+   * Sleeps for the provided amount of time in milliseconds.
+   * @param data
+   */
   sleep: async (data: number) => {
     await new Promise<void>((resolve) => {
       const timer = setTimeout(resolve, data);
@@ -29,6 +42,9 @@ const worker = {
     });
     return { data: undefined };
   },
+  /**
+   * Test function that takes a transferred ArrayBuffer and fills it with 0x0F bytes.
+   */
   transferBuffer: async (data: ArrayBuffer, _transferList?: [ArrayBuffer]) => {
     const buffer = Buffer.from(data, 0, data.byteLength);
     buffer.fill(0xf);