X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=5a6c328aab5f2b795e58943f93df8e7b516f3094;hb=71056a0ac555e096c1428d6341ef45c7980a6332;hp=bdbc86e09a07d403792ff8303bea99e4f8aaebc9;hpb=fa6436344997918dbda3e94063b4c2e2e4a892c3;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index bdbc86e0..5a6c328a 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier
+WorkerOptions | poolifier
-
+
  • poolifier
    • @@ -17,13 +17,14 @@

    Interface WorkerOptions

Options for workers.

-
+
+

Hierarchy

  • WorkerOptions
+
  • Defined in src/worker/worker-options.ts:38
    • @@ -31,38 +32,42 @@

    Properties

    -
    async? -killBehavior? -maxInactiveTime? +
    async? +killBehavior? +maxInactiveTime?

    Properties

    -
    -

    Optional async

    -
    async?: boolean
    +
    +

    Optional async

    +
    async?: boolean

    Whether your worker will perform asynchronous or not.

    +
    +
    +

    Default Value

    false

    -

    Default Value

    false

    +

    Deprecated

    This option will be removed in the next major version.

    -
    -

    Optional killBehavior

    -
    killBehavior?: "SOFT" | "HARD"
    +
  • Defined in src/worker/worker-options.ts:58
    • +
    +

    Optional killBehavior

    +
    killBehavior?: "SOFT" | "HARD"

    killBehavior dictates if your async unit (worker/process) will be deleted in case that a task is active on it.

    • SOFT: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker won't be deleted.
    • HARD: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker will be deleted.

    This option only apply to the newly created workers.

    - -

    Default Value

    KillBehaviors.SOFT

    +
    +
    +

    Default Value

    KillBehaviors.SOFT

    -
    -

    Optional maxInactiveTime

    -
    maxInactiveTime?: number
    +
  • Defined in src/worker/worker-options.ts:69
    • +
    +

    Optional maxInactiveTime

    +
    maxInactiveTime?: number

    Maximum waiting time in milliseconds for tasks.

    After this time, newly created workers will be terminated. The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.

    @@ -71,15 +76,17 @@ The last active time of your worker unit will be updated when a task is submitte when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.
  • If killBehavior is set to KillBehaviors.SOFT your tasks have no timeout and your workers will not be terminated until your task is completed.
    • - -

    Default Value

    60000 ms

    +
    +
    +

    Default Value

    60000

    -
    +
  • Defined in src/worker/worker-options.ts:51
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -89,21 +96,67 @@ when this timeout expires your tasks is interrupted and the worker is killed if
    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • async
    • +
  • killBehavior
    • +
  • maxInactiveTime
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file