X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=11461b2968b31d8e1930a4c97f6dd9afd591808d;hb=1ed7fb6c99f2fcb5f319d9c1fa2aefc5434f82e4;hp=fdd61f0ea8cf6209c8de9c64d0161aab687744cb;hpb=3882157ecadc80e686b319068bd73a9cc218e10c;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index fdd61f0e..11461b29 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,13 +1,13 @@ -IWorkerChoiceStrategy | poolifier - v2.6.30
+IWorkerChoiceStrategy | poolifier - v3.0.2
-
+
  • The search index is not available
    • poolifier - v3.0.2 +
    @@ -24,15 +24,15 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • - +

    Properties

    -
    choose +
    choose remove reset setOptions @@ -43,22 +43,24 @@

    Properties

    -

    Readonly 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 no worker nodes are not eligible, undefined is returned. +If undefined is returned, the caller retry.

        -

        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:197

    • Readonly remove

    remove: ((workerNodeKey) => boolean)
    @@ -83,7 +85,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:204

    • Readonly reset

    reset: (() => boolean)
    @@ -100,7 +102,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182

    • Readonly setOptions

    setOptions: ((opts) => void)
    @@ -124,7 +126,7 @@

    Returns void

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

    • Readonly strategyPolicy

    strategyPolicy: StrategyPolicy
    @@ -132,7 +134,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172

    • Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -140,7 +142,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:176

    • Readonly update

    update: ((workerNodeKey) => boolean)
    @@ -151,7 +153,8 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -190,68 +193,30 @@
  • taskStatisticsRequirements
  • update
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file