X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=153e6513a232970458cf160be99a84ac55a12c26;hb=da66e34cda2cbcb3a94865d24696c668f50a1437;hp=a0a7643c7e49e4c4860b37217fdb84882def9581;hpb=dde90273424a8c6dbfaddcc7e6a771623c521f2c;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index a0a7643c..153e6513 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,61 +1,67 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    -

    Interface IWorkerChoiceStrategy

    +

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    -
    +
    +

    Hierarchy

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

    Properties

    -
    choose -remove -requiredStatistics -reset -setOptions +
    choose +remove +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

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

    remove

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

    @@ -64,7 +70,7 @@
    -

    Returns boolean

    -
    -

    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

    @@ -93,13 +95,15 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
    • -

    setOptions

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

    @@ -116,78 +120,101 @@
  • opts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    • -

    Returns void

    +
    +

    Readonly strategyPolicy

    +
    strategyPolicy: StrategyPolicy
    +

    Strategy policy.

    +
    +
    +
    +

    Readonly taskStatisticsRequirements

    +
    taskStatisticsRequirements: TaskStatisticsRequirements
    +

    Tasks statistics requirements.

    +
    +
    +
    +

    Readonly update

    +
    update: ((workerNodeKey) => boolean)
    +
    +

    Type declaration

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    -

    On This Page

     +

    On This Page

    +
  • choose
    • +
  • remove
    • +
  • reset
    • +
  • setOptions
    • +
  • strategyPolicy
    • +
  • taskStatisticsRequirements
    • +
  • update
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file