X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=e22b94f4c5523a658f909fcbc358c155c5c0bf7f;hb=d655c2c2b159a39f900230c14b301ba123653362;hp=a47f24d67bd2faf32878040ba82039a83569ec5f;hpb=4101537483d2883af1f76ef2366bb7e92d0d3c4e;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index a47f24d6..e22b94f4 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier
+WorkerOptions | poolifier
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier
    -
    +
    @@ -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

    • 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
    @@ -72,14 +72,15 @@ 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
    • +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -90,20 +91,54 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    • Theme

    - -
    -
    +
  • async
    • +
  • killBehavior
    • +
  • maxInactiveTime
    • +
    +
    +

    Generated using TypeDoc

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