X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=9cd1e2749f322c4dc32c0c840336f63995fc0b11;hb=b9f66dae32dbfe46e83c7a498c133855fc6af2a2;hp=a93f631bbcef12a7e1ad88a9592d0d55af547b7b;hpb=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index a93f631b..9cd1e274 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,20 +1,20 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v3.0.0
-
+
  • The search index is not available
    • poolifier - v3.0.0 +
    -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

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

    Properties

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

    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 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
    • -

    remove

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

    @@ -83,9 +85,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:204
    • -

    reset

    +

    Readonly reset

    reset: (() => boolean)

    Type declaration

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

    setOptions

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

    @@ -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,9 +142,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
    • -

    update

    +

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

    @@ -151,7 +153,8 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
    • -

    Settings

     +

    Settings

    Member Visibility

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file