X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=f1fe5415797136b04ce7d753929f9c4076822675;hb=e1230e386080ae19766e2a7863c807a90f13a3ef;hp=bf4f7133a4f2967e1fcb6e821fabc20d78041e29;hpb=d61f24ac46792cfab91a154667f24fc57c90e66e;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index bf4f7133..f1fe5415 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,11 +1,13 @@ WorkerOptions | poolifier
-
+
@@ -21,7 +23,7 @@
  • WorkerOptions
+
  • Defined in src/worker/worker-options.ts:38
    • @@ -40,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

    • 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 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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -70,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