docs: add missing exports
authorJérôme Benoit <jerome.benoit@sap.com>
Tue, 11 Apr 2023 19:55:30 +0000 (21:55 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Tue, 11 Apr 2023 19:55:30 +0000 (21:55 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/index.ts
src/pools/pool.ts
src/pools/worker.ts

index 7a246505c502e9256d0506e8420fc57d8acdeef9..ad0af4875b64cf176ba7718fec69d60403412735 100644 (file)
@@ -2,10 +2,17 @@ export { DynamicClusterPool } from './pools/cluster/dynamic'
 export { FixedClusterPool } from './pools/cluster/fixed'
 export type { ClusterPoolOptions } from './pools/cluster/fixed'
 export { PoolEvents } from './pools/pool'
-export type { IPool, PoolEmitter, PoolOptions, PoolEvent } from './pools/pool'
+export type {
+  IPool,
+  PoolEmitter,
+  PoolOptions,
+  PoolEvent,
+  TasksQueueOptions
+} from './pools/pool'
 export type {
   ErrorHandler,
   ExitHandler,
+  IWorker,
   MessageHandler,
   OnlineHandler
 } from './pools/worker'
index 2cdf9b748db6350b0bfa7c9e64aedd8b32b296cf..fe03741a68254c686991c5ed6b222857e1ff70c8 100644 (file)
@@ -86,7 +86,6 @@ export interface PoolOptions<Worker extends IWorker> {
    * Pool worker tasks queue options.
    *
    * @experimental
-   * @defaultValue \{ concurrency: 1 \}
    */
   tasksQueueOptions?: TasksQueueOptions
 }
index 1e23ee872aa0b9f1a5ae97d48c2a8c87b06e6567..1f8efbc66e429bc65f58aa8ecbcf5b9807f88f6d 100644 (file)
@@ -33,7 +33,13 @@ export type ExitHandler<Worker extends IWorker> = (
  * Worker task interface.
  */
 export interface Task<Data = unknown> {
+  /**
+   * Worker task data.
+   */
   data: Data
+  /**
+   * Task UUID.
+   */
   id: string
 }