repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
fix: fix worker choice strategy options default value
[poolifier.git]
/
src
/
pools
/
selection-strategies
/
selection-strategies-types.ts
diff --git
a/src/pools/selection-strategies/selection-strategies-types.ts
b/src/pools/selection-strategies/selection-strategies-types.ts
index bf364f923d033e24223afed35b07f3bdaaf1517b..fa0d0f641a4b8618efa7346a3ba4029a93bc533b 100644
(file)
--- a/
src/pools/selection-strategies/selection-strategies-types.ts
+++ b/
src/pools/selection-strategies/selection-strategies-types.ts
@@
-1,6
+1,3
@@
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
-
/**
* Enumeration of worker choice strategies.
*/
/**
* Enumeration of worker choice strategies.
*/
@@
-32,32
+29,44
@@
export const WorkerChoiceStrategies = Object.freeze({
*/
export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
*/
export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
+/**
+ * Worker choice strategy options.
+ */
+export interface WorkerChoiceStrategyOptions {
+ /**
+ * Use tasks median run time instead of average run time.
+ *
+ * @defaultValue false
+ */
+ medRunTime?: boolean
+}
+
/**
* Pool worker tasks usage statistics requirements.
/**
* Pool worker tasks usage statistics requirements.
+ *
+ * @internal
*/
export interface RequiredStatistics {
*/
export interface RequiredStatistics {
+ /**
+ * Require tasks run time.
+ */
runTime: boolean
runTime: boolean
+ /**
+ * Require tasks average run time.
+ */
avgRunTime: boolean
avgRunTime: boolean
+ /**
+ * Require tasks median run time.
+ */
+ medRunTime: boolean
}
/**
* Worker choice strategy interface.
*/
}
/**
* Worker choice strategy interface.
*/
-export interface IWorkerChoiceStrategy<
- Worker extends IPoolWorker,
- Data = unknown,
- Response = unknown
-> {
- /**
- * The pool instance.
- */
- readonly pool: IPoolInternal<Worker, Data, Response>
+export interface IWorkerChoiceStrategy {
/**
/**
- * Is the pool attached to the strategy dynamic?.
- */
- readonly isDynamicPool: boolean
- /**
- * Required pool tasks usage statistics.
+ * Required tasks usage statistics.
*/
readonly requiredStatistics: RequiredStatistics
/**
*/
readonly requiredStatistics: RequiredStatistics
/**
@@
-65,13
+74,19
@@
export interface IWorkerChoiceStrategy<
*/
reset: () => boolean
/**
*/
reset: () => boolean
/**
- * Chooses a worker in the pool and returns its key.
+ * Chooses a worker
node
in the pool and returns its key.
*/
choose: () => number
/**
*/
choose: () => number
/**
- * Removes a worker reference from strategy internals.
+ * Removes a worker node key from strategy internals.
+ *
+ * @param workerNodeKey - The worker node key.
+ */
+ remove: (workerNodeKey: number) => boolean
+ /**
+ * Sets the worker choice strategy options.
*
*
- * @param
workerKey - The worker key
.
+ * @param
opts - The worker choice strategy options
.
*/
*/
- remove: (workerKey: number) => boolean
+ setOptions: (opts: WorkerChoiceStrategyOptions) => void
}
}