X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=dd9ae8d096761f959a17c8ca792f9d9ffec6a92b;hb=410724041bab556be1385c56f9a32e5030f6f2cf;hp=a93f631bbcef12a7e1ad88a9592d0d55af547b7b;hpb=c4dfd49dbde2f3af0adc4a33d582b1c653f859b5;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index a93f631b..dd9ae8d0 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,20 +1,20 @@ -IWorkerChoiceStrategy | poolifier
+IWorkerChoiceStrategy | poolifier - v2.7.3
-
+
  • The search index is not available
  • poolifier - v2.7.3 +
    -

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

    Type declaration

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

    Type declaration

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

    Type declaration

    @@ -124,7 +126,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:210
  • strategyPolicy: StrategyPolicy
    @@ -132,7 +134,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
  • taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -140,9 +142,9 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
  • - +
    update: ((workerNodeKey) => boolean)

    Type declaration

    @@ -151,7 +153,8 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
  • @@ -190,66 +193,30 @@
  • taskStatisticsRequirements
  • update
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file