X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=2a26aa92168097da72bc97828e35920e02a41dc0;hb=cdec20cb33f3f3c2da6f2645d74f78f6551e85e0;hp=1fe1cbc280edf88326f6a8e27ccf1d4c8282a701;hpb=c8a9d1714b7b1d592a73751ad6f580121cf75f7f;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 1fe1cbc2..2a26aa92 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,13 +1,13 @@ -IWorkerChoiceStrategy | poolifier - v2.6.38
+IWorkerChoiceStrategy | poolifier - v2.7.4
-
+
  • The search index is not available
    • poolifier - v2.7.4 +
    @@ -24,15 +24,15 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • - +

    Properties

    -
    choose +
    choose remove reset setOptions @@ -43,7 +43,7 @@

    Properties

    -

    Readonly choose

    +

    Readonly choose

    choose: (() => undefined | number)

    Type declaration

    @@ -53,13 +53,14 @@
  • (): undefined | number

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

    +If no worker nodes are not eligible, undefined is returned. +If undefined is returned, the caller retry.

    Returns undefined | number

    The worker node key or undefined.

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

    • Readonly remove

    remove: ((workerNodeKey) => boolean)
    @@ -78,12 +79,13 @@ If the worker node is not eligible, undefined is returned.

  • workerNodeKey: number

    The worker node key.

    -
    • +
    +

    Returns boolean

    true if the worker node key is removed, false otherwise.

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

    • Readonly reset

    reset: (() => boolean)
    @@ -100,7 +102,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly setOptions

    setOptions: ((opts) => void)
    @@ -119,11 +121,12 @@ If the worker node is not eligible, undefined is returned.

  • opts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    • + +

    Returns void

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

    • Readonly strategyPolicy

    strategyPolicy: StrategyPolicy
    @@ -131,7 +134,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -139,7 +142,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly update

    update: ((workerNodeKey) => boolean)
    @@ -150,7 +153,8 @@ If the worker node is not eligible, undefined is returned.

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -189,71 +193,30 @@ If the worker node is not eligible, undefined is returned.

  • taskStatisticsRequirements
  • update
    • -
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file