X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=4cab7975aa43603aba7b228ab65582643db21e03;hb=1a880eca683648d5228e2424db74553f58ecee7d;hp=622ee944a8a13180f5ac71085b2512cfd5783324;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 622ee944..4cab7975 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.36
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.36
    @@ -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

    Properties

    - -
    choose: (() => number)
    + +
    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: ((workerNodeKey) => boolean)

    Type declaration

    @@ -76,23 +78,14 @@
  • workerNodeKey: number

    The worker node key.

    -
    -
  • +

    Returns boolean

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

    -
    - -
    requiredStatistics: RequiredStatistics
    -

    Required tasks usage statistics.

    -
    -
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:202
  • - +
    reset: (() => boolean)

    Type declaration

    @@ -107,9 +100,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
  • - +
    setOptions: ((opts) => void)

    Type declaration

    @@ -126,14 +119,29 @@
  • opts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    -
  • +

    Returns void

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

    Strategy policy.

    +
    +
    +
    + +
    taskStatisticsRequirements: TaskStatisticsRequirements
    +

    Tasks statistics requirements.

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

    Type declaration

    @@ -153,7 +161,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
  • +
  • WorkerTypes
  • +
  • availableParallelism
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file