X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=563ab71cec3e3fd19c0560f80b4983fc54b63a49;hb=94ab998f44abe7ed2184a0702c45621b06f5641f;hp=e209d7bad8fccec1b222a315a805cdbaa7722255;hpb=0163b91de7e67e0c3b29b542bd2d47cce655b262;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index e209d7ba..563ab71c 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -6,7 +6,7 @@ poolifier +
  • The search index is not available
  • poolifier
    @@ -23,7 +23,7 @@ +
  • Defined in src/worker/worker-options.ts:38
  • @@ -42,24 +42,24 @@
    async?: boolean

    Whether your worker will perform asynchronous or not.

    -

    Default

    false

    +

    Default Value

    false

    +
  • Defined in src/worker/worker-options.ts:57
  • 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 lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker will 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

    KillBehaviors.SOFT

    +

    Default Value

    KillBehaviors.SOFT

    +
  • Defined in src/worker/worker-options.ts:68
  • maxInactiveTime?: number
    @@ -72,10 +72,10 @@ when this timeout expires your tasks is interrupted and the worker is killed if
  • 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

    60000 ms

    +

    Default Value

    60000 ms

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