refactor: move workerId outside task type definition
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 16 Nov 2023 22:09:04 +0000 (23:09 +0100)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 16 Nov 2023 22:09:04 +0000 (23:09 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/pools/pool.ts
src/utility-types.ts

index af80bcfbebcee352f2dc0c09dc6a6754e75ec0bf..581adc952c1e5a1a1b7e1f11c033283dc5df5fa5 100644 (file)
@@ -241,7 +241,7 @@ export interface IPool<
    *
    * @param data - The optional task input data for the specified task function. This can only be structured-cloneable data.
    * @param name - The optional name of the task function to execute. If not specified, the default task function will be executed.
-   * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+   * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
    * @returns Promise that will be fulfilled when the task is completed.
    */
   readonly execute: (
index 48988c089f6717e1e4108143ce87c20bdc5536d1..60ec2f546fe50f2ab14ea96b49b60d839dd12ea0 100644 (file)
@@ -69,10 +69,6 @@ export interface WorkerStatistics {
  * @internal
  */
 export interface Task<Data = unknown> {
-  /**
-   * Worker id.
-   */
-  readonly workerId?: number
   /**
    * Task name.
    */
@@ -104,6 +100,10 @@ export interface Task<Data = unknown> {
  */
 export interface MessageValue<Data = unknown, ErrorData = unknown>
   extends Task<Data> {
+  /**
+   * Worker id.
+   */
+  readonly workerId?: number
   /**
    * Kill code.
    */