repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
chore: v2.4.4
[poolifier.git]
/
src
/
pools
/
pool.ts
diff --git
a/src/pools/pool.ts
b/src/pools/pool.ts
index 78e7c981b6d9e25efb0c3af38d5cab2c4a3f6014..f1da5356a2e5310d799b6e595a898a3aad783600 100644
(file)
--- a/
src/pools/pool.ts
+++ b/
src/pools/pool.ts
@@
-1,4
+1,4
@@
-import EventEmitter from 'events'
+import EventEmitter from '
node:
events'
import type {
ErrorHandler,
ExitHandler,
import type {
ErrorHandler,
ExitHandler,
@@
-12,6
+12,19
@@
import type { WorkerChoiceStrategy } from './selection-strategies/selection-stra
*/
export class PoolEmitter extends EventEmitter {}
*/
export class PoolEmitter extends EventEmitter {}
+/**
+ * Enumeration of pool events.
+ */
+export const PoolEvents = Object.freeze({
+ full: 'full',
+ busy: 'busy'
+} as const)
+
+/**
+ * Pool event.
+ */
+export type PoolEvent = keyof typeof PoolEvents
+
/**
* Options for a poolifier pool.
*/
/**
* Options for a poolifier pool.
*/
@@
-39,7
+52,7
@@
export interface PoolOptions<Worker> {
/**
* Pool events emission.
*
/**
* Pool events emission.
*
- * @default true
+ * @default
Value
true
*/
enableEvents?: boolean
}
*/
enableEvents?: boolean
}
@@
-47,8
+60,8
@@
export interface PoolOptions<Worker> {
/**
* Contract definition for a poolifier pool.
*
/**
* Contract definition for a poolifier pool.
*
- * @t
emplate Data
Type of data sent to the worker. This can only be serializable data.
- * @t
emplate Response
Type of response of execution. This can only be serializable data.
+ * @t
ypeParam Data -
Type of data sent to the worker. This can only be serializable data.
+ * @t
ypeParam Response -
Type of response of execution. This can only be serializable data.
*/
export interface IPool<Data = unknown, Response = unknown> {
/**
*/
export interface IPool<Data = unknown, Response = unknown> {
/**
@@
-56,24
+69,25
@@
export interface IPool<Data = unknown, Response = unknown> {
*
* Events that can currently be listened to:
*
*
* Events that can currently be listened to:
*
- * - `'busy'`
+ * - `'full'`: Emitted when the pool is dynamic and full.
+ * - `'busy'`: Emitted when the pool is busy.
*/
readonly emitter?: PoolEmitter
/**
* Performs the task specified in the constructor with the data parameter.
*
*/
readonly emitter?: PoolEmitter
/**
* Performs the task specified in the constructor with the data parameter.
*
- * @param data The input for the specified task. This can only be serializable data.
+ * @param data
-
The input for the specified task. This can only be serializable data.
* @returns Promise that will be resolved when the task is successfully completed.
*/
* @returns Promise that will be resolved when the task is successfully completed.
*/
- execute
(data: Data):
Promise<Response>
+ execute
: (data: Data) =>
Promise<Response>
/**
* Shutdowns every current worker in this pool.
*/
/**
* Shutdowns every current worker in this pool.
*/
- destroy
():
Promise<void>
+ destroy
: () =>
Promise<void>
/**
* Sets the worker choice strategy in this pool.
*
/**
* Sets the worker choice strategy in this pool.
*
- * @param workerChoiceStrategy The worker choice strategy.
+ * @param workerChoiceStrategy
-
The worker choice strategy.
*/
*/
- setWorkerChoiceStrategy
(workerChoiceStrategy: WorkerChoiceStrategy):
void
+ setWorkerChoiceStrategy
: (workerChoiceStrategy: WorkerChoiceStrategy) =>
void
}
}