X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=58a7d9e44d27b62e46e49c920dda26c413336307;hb=2771e5dcac6411a9731c66730072fcc578ff701c;hp=e2c124d1f8fc01b6465e312b68fb03fd551c2673;hpb=46e29227a97fe04f886969199f1c14338af50543;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index e2c124d1..58a7d9e4 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,13 +1,13 @@ -WorkerOptions | poolifier - v2.6.30
+WorkerOptions | poolifier - v2.7.2
-
+
  • The search index is not available
    • poolifier - v2.7.2 +
    @@ -24,15 +24,15 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:28
    • - +

    Properties

    -
    async? +
    async? killBehavior? killHandler? maxInactiveTime? @@ -40,17 +40,18 @@

    Properties

    -

    Optional async

    +

    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.

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

    • Optional killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -62,22 +63,25 @@

    This option only apply to the newly created workers.

    -

    Default Value

    KillBehaviors.SOFT

    +

    Default Value

    KillBehaviors.SOFT
+
    +
  • Defined in src/worker/worker-options.ts:39

    • Optional killHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    -

    Maximum waiting time in milliseconds for tasks on newly created workers.

    +

    Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.

    After this time, newly created workers will be terminated. The last active time of your worker will be updated when it terminates a task.

      @@ -87,23 +91,24 @@ when this timeout expires your tasks is interrupted before completion and remove
    -

    Default Value

    60000

    +

    Default Value

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -115,68 +120,30 @@ when this timeout expires your tasks is interrupted before completion and remove
  • killHandler
  • maxInactiveTime
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file