X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=61f31b63411520d2ef6e2f8ee773f1a4bf239e62;hb=2041f3d8b2564bfab8e30db6a87dba283219ca86;hp=2267ee40681fe4121460c0c2bb7a04870fbe8ce4;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 2267ee40..61f31b63 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -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
  • @@ -36,30 +36,32 @@ remove reset setOptions +strategyPolicy taskStatisticsRequirements update

    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,15 +78,14 @@
  • 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:202
  • - +
    reset: (() => boolean)

    Type declaration

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

    Type declaration

    @@ -118,12 +119,19 @@
  • 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
    @@ -131,9 +139,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
  • - +
    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