repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
docs: fix findFreeWorkerKey() return value
[poolifier.git]
/
src
/
pools
/
pool-internal.ts
diff --git
a/src/pools/pool-internal.ts
b/src/pools/pool-internal.ts
index 9489d96f1c1ffc3ef548a06423b2bb05647bf277..c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df 100644
(file)
--- a/
src/pools/pool-internal.ts
+++ b/
src/pools/pool-internal.ts
@@
-3,6
+3,8
@@
import type { IPoolWorker } from './pool-worker'
/**
* Internal pool types.
/**
* Internal pool types.
+ *
+ * @enum
*/
export enum PoolType {
FIXED = 'fixed',
*/
export enum PoolType {
FIXED = 'fixed',
@@
-17,12
+19,13
@@
export interface TasksUsage {
running: number
runTime: number
avgRunTime: number
running: number
runTime: number
avgRunTime: number
+ error: number
}
/**
* Internal worker type.
*
}
/**
* Internal worker type.
*
- * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Worker - Type of worker
type items
which manages this pool.
*/
export interface WorkerType<Worker extends IPoolWorker> {
worker: Worker
*/
export interface WorkerType<Worker extends IPoolWorker> {
worker: Worker
@@
-33,8
+36,8
@@
export interface WorkerType<Worker extends IPoolWorker> {
* Internal contract definition for a poolifier pool.
*
* @typeParam Worker - Type of worker which manages this pool.
* Internal contract definition for a poolifier pool.
*
* @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker.
- * @typeParam Response - Type of response of execution.
+ * @typeParam Data - Type of data sent to the worker.
This can only be serializable data.
+ * @typeParam Response - Type of response of execution.
This can only be serializable data.
*/
export interface IPoolInternal<
Worker extends IPoolWorker,
*/
export interface IPoolInternal<
Worker extends IPoolWorker,
@@
-42,7
+45,7
@@
export interface IPoolInternal<
Response = unknown
> extends IPool<Data, Response> {
/**
Response = unknown
> extends IPool<Data, Response> {
/**
- * Pool worker
s item
array.
+ * Pool worker
type items
array.
*/
readonly workers: Array<WorkerType<Worker>>
*/
readonly workers: Array<WorkerType<Worker>>
@@
-54,33
+57,27
@@
export interface IPoolInternal<
readonly type: PoolType
/**
readonly type: PoolType
/**
- * Whether the pool is
busy
or not.
+ * Whether the pool is
full
or not.
*
*
- * The pool
busyness
boolean status.
+ * The pool
filling
boolean status.
*/
*/
- readonly
busy
: boolean
+ readonly
full
: boolean
/**
/**
- * Number of tasks currently concurrently running.
+ * Whether the pool is busy or not.
+ *
+ * The pool busyness boolean status.
*/
*/
- readonly
numberOfRunningTasks: number
+ readonly
busy: boolean
/**
/**
- * Finds a free worker based on the number of tasks the worker has applied.
- *
- * If a worker is found with `0` running tasks, it is detected as free and returned.
+ * Finds a free worker key based on the number of tasks the worker has applied.
*
*
- * If
no free worker is found, `false`
is returned.
+ * If
a worker is found with `0` running tasks, it is detected as free and its key
is returned.
*
*
- * @returns A free worker if there is one, otherwise `false`.
- */
- findFreeWorker: () => Worker | false
-
- /**
- * Gets worker tasks usage.
+ * If no free worker is found, `-1` is returned.
*
*
- * @param worker - The worker.
- * @returns The tasks usage on the worker.
+ * @returns A worker key if there is one, `-1` otherwise.
*/
*/
- getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined
+ findFreeWorkerKey: () => number
}
}