docs: refine README to include latest API changes

[poolifier.git] / src / pools / pool.ts

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 0013bf5dc20a27a9b84b63645233d2e636c9df49..8aae69d463323557197da4a749072989060c0b6a 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -31,6 +31,19 @@ export const PoolTypes = Object.freeze({
  */
 export type PoolType = keyof typeof PoolTypes
 
+/**
+ * Enumeration of worker types.
+ */
+export const WorkerTypes = Object.freeze({
+  cluster: 'cluster',
+  thread: 'thread'
+} as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
+
 /**
  * Pool events emitter.
  */
@@ -56,6 +69,7 @@ export type PoolEvent = keyof typeof PoolEvents
  */
 export interface PoolInfo {
   type: PoolType
+  worker: WorkerType
   minSize: number
   maxSize: number
   workerNodes: number
@@ -144,12 +158,6 @@ export interface IPool<
   Data = unknown,
   Response = unknown
 > {
-  /**
-   * Pool type.
-   *
-   * If it is `'dynamic'`, it provides the `max` property.
-   */
-  readonly type: PoolType
   /**
    * Pool information.
    */