X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=c95ecd3e4dabd72c525d8a61fbaa911ec1a44f4c;hb=fd98bbb90c7202f5dd734c029f3cee2f997aea24;hp=622ee944a8a13180f5ac71085b2512cfd5783324;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 622ee944..c95ecd3e 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.32
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.32
    @@ -14,7 +14,7 @@ -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    @@ -24,7 +24,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • @@ -34,32 +34,34 @@

    Properties

    choose remove -requiredStatistics reset setOptions +strategyPolicy +taskStatisticsRequirements update

    Properties

    -

    choose

    -
    choose: (() => number)
    +

    Readonly choose

    +
    choose: (() => undefined | number)

    Type declaration

      • -
      • (): number
        • +
      • (): undefined | number
      • -

        Chooses a worker node in the pool and returns its key.

        +

        Chooses a worker node in the pool and returns its key. +If the worker node is not eligible, undefined is returned.

        -

        Returns number

        The worker node key.

        +

        Returns undefined | number

        The worker node key or undefined.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:195
    • -

    remove

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

    @@ -82,17 +84,9 @@
    -
    -

    Readonly requiredStatistics

    -
    requiredStatistics: RequiredStatistics
    -

    Required tasks usage statistics.

    -
    -
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:202
    • -

    reset

    +

    Readonly reset

    reset: (() => boolean)

    Type declaration

    @@ -107,9 +101,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
    • -

    setOptions

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

    @@ -131,9 +125,25 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:208
    • +
    +

    Readonly strategyPolicy

    +
    strategyPolicy: StrategyPolicy
    +

    Strategy policy.

    +
    +
    +
    +

    Readonly taskStatisticsRequirements

    +
    taskStatisticsRequirements: TaskStatisticsRequirements
    +

    Tasks statistics requirements.

    +
    +
    -

    update

    +

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

    @@ -153,7 +163,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
    • @@ -175,60 +185,74 @@
    -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file