X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=6e69b4a6d0f5be178cc6df3e3a517159587e0ae1;hb=1659c4c164485a043f80c746410501e888676dc7;hp=f1fe5415797136b04ce7d753929f9c4076822675;hpb=e1230e386080ae19766e2a7863c807a90f13a3ef;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index f1fe5415..6e69b4a6 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier
+WorkerOptions | poolifier
-
+
@@ -31,24 +31,26 @@

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

+ +

Deprecated

This option will be removed in the next major version.

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

    Optional killBehavior

    -
    killBehavior?: "SOFT" | "HARD"
    +
    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.
      • @@ -59,10 +61,10 @@

      Default Value

      KillBehaviors.SOFT

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

    Optional maxInactiveTime

    -
    maxInactiveTime?: number
    +
    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.

    @@ -72,14 +74,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 Value

    60000 ms

    +

    Default Value

    60000

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

    Settings

     +

    Settings

    Member Visibility

    @@ -89,21 +92,64 @@ 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