X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=78cabf7a8846cc519b696734065d9ff46d33df6b;hb=1ed7fb6c99f2fcb5f319d9c1fa2aefc5434f82e4;hp=ec58f3abe405103b7b745eee25e6d0493488bb29;hpb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index ec58f3ab..78cabf7a 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -WorkerOptions | poolifier - v2.6.42
+WorkerOptions | poolifier - v3.0.2
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.42
+
  • The search index is not available
    • poolifier - v3.0.2
    @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:28
    • @@ -32,26 +32,12 @@

    Properties

    -
    async? -killBehavior? +
    killBehavior? killHandler? maxInactiveTime?

    Properties

    -
    -

    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.

    -

    Optional killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -63,23 +49,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.

      @@ -93,7 +81,7 @@ when this timeout expires your tasks is interrupted before completion and remove
    +
  • Defined in src/worker/worker-options.ts:52
    • @@ -103,22 +91,21 @@ when this timeout expires your tasks is interrupted before completion and remove

    Member Visibility

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

    • Theme

    On This Page
    -

    Generated using TypeDoc

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