X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=e53f3e822967b43a7d6f11ca0b34e6e3a9e7ed4e;hb=8e5ca0401467b0a5c40b20a40ef08db6c05b9561;hp=7a5a10c6018fda998f61143c42b47fb9bd4d8e41;hpb=247ce01eb1230d22b93252db1732d626d2745f9e;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 7a5a10c6..e53f3e82 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -62,7 +62,7 @@ export interface MeasurementOptions { /** * Set measurement median. */ - median: boolean + readonly median: boolean } /** @@ -72,32 +72,32 @@ export interface WorkerChoiceStrategyOptions { /** * Measurement to use for worker choice strategy. */ - measurement?: Measurement + readonly measurement?: Measurement /** * Runtime options. * * @defaultValue \{ median: false \} */ - runTime?: MeasurementOptions + readonly runTime?: MeasurementOptions /** * Wait time options. * * @defaultValue \{ median: false \} */ - waitTime?: MeasurementOptions + readonly waitTime?: MeasurementOptions /** * Event loop utilization options. * * @defaultValue \{ median: false \} */ - elu?: MeasurementOptions + readonly elu?: MeasurementOptions /** * Worker weights to use for weighted round robin worker selection strategy. * Weight is the tasks maximum average or median runtime in milliseconds. * * @defaultValue Computed worker weights automatically given the CPU performance. */ - weights?: Record + readonly weights?: Record } /** @@ -107,15 +107,15 @@ export interface WorkerChoiceStrategyOptions { */ export interface MeasurementStatisticsRequirements { /** - * Require measurement aggregate. + * Requires measurement aggregate. */ aggregate: boolean /** - * Require measurement average. + * Requires measurement average. */ average: boolean /** - * Require measurement median. + * Requires measurement median. */ median: boolean } @@ -129,15 +129,15 @@ export interface TaskStatisticsRequirements { /** * Tasks runtime requirements. */ - runTime: MeasurementStatisticsRequirements + readonly runTime: MeasurementStatisticsRequirements /** * Tasks wait time requirements. */ - waitTime: MeasurementStatisticsRequirements + readonly waitTime: MeasurementStatisticsRequirements /** * Tasks event loop utilization requirements. */ - elu: MeasurementStatisticsRequirements + readonly elu: MeasurementStatisticsRequirements } /** @@ -147,13 +147,15 @@ export interface TaskStatisticsRequirements { */ export interface StrategyPolicy { /** - * Expect direct usage of dynamic worker. + * Expects direct usage of dynamic worker. */ - useDynamicWorker: boolean + readonly useDynamicWorker: boolean } /** * Worker choice strategy interface. + * + * @internal */ export interface IWorkerChoiceStrategy { /** @@ -169,30 +171,30 @@ export interface IWorkerChoiceStrategy { * * @returns `true` if the reset is successful, `false` otherwise. */ - reset: () => boolean + readonly reset: () => boolean /** * Updates the worker node key strategy internals. * * @returns `true` if the update is successful, `false` otherwise. */ - update: (workerNodeKey: number) => boolean + readonly update: (workerNodeKey: number) => boolean /** * Chooses a worker node in the pool and returns its key. * * @returns The worker node key. */ - choose: () => number + readonly choose: () => number /** * Removes the worker node key from strategy internals. * * @param workerNodeKey - The worker node key. * @returns `true` if the worker node key is removed, `false` otherwise. */ - remove: (workerNodeKey: number) => boolean + readonly remove: (workerNodeKey: number) => boolean /** * Sets the worker choice strategy options. * * @param opts - The worker choice strategy options. */ - setOptions: (opts: WorkerChoiceStrategyOptions) => void + readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void }