docs: align type definitions
authorJérôme Benoit <jerome.benoit@sap.com>
Tue, 11 Apr 2023 22:50:09 +0000 (00:50 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Tue, 11 Apr 2023 22:50:09 +0000 (00:50 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/pool.ts
src/worker/worker-options.ts

index 4395712f801d3f69961eb6e57bbef6e333d6c713..6b957c372cfd2346b4d56bbbae46ce2015ea155f 100644 (file)
@@ -61,7 +61,7 @@ export interface TasksQueueOptions {
 /**
  * Options for a poolifier pool.
  *
- * @typeParam Worker - The worker type.
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
   /**
index 4e5a3d07d99c372b5d24854471d6b97f9c297566..30da0a64c4688679c3730a635fd9c76c5feaf5b2 100644 (file)
@@ -20,7 +20,7 @@ export type KillBehavior = keyof typeof KillBehaviors
 /**
  * Detects whether the given value is a kill behavior or not.
  *
- * @typeParam KB - Which specific KillBehavior to test against.
+ * @typeParam KB - Which specific KillBehavior type to test against.
  * @param killBehavior - Which kind of kill behavior to detect.
  * @param value - Any value.
  * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.