X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=ade11e3eac59bd62d45afb6b3f6d873610956571;hb=9aa78bcb34d9d6002c71ce3de1ece85dd164871f;hp=f7c27662c7858ec564eebb360a4cfee812f6a8ab;hpb=b7ca12ae3bfb54a42c0e9879067fc3a976685bb7;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index f7c27662..ade11e3e 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,83 +1,18 @@ -WorkerOptions | poolifier - v2.6.32
-
- -
-
-
-
- -

Interface WorkerOptions

-
-

Options for workers.

-
-
-
-

Hierarchy

-
    -
  • WorkerOptions
-
-
-
- -
-
-

Properties

-
async? -killBehavior? +WorkerOptions | poolifier - v3.0.11

Interface WorkerOptions

Options for workers.

+
interface WorkerOptions {
    killBehavior?: "SOFT" | "HARD";
    killHandler?: KillHandler;
    maxInactiveTime?: number;
}
-
-

Properties

-
- -
async?: boolean
-

Whether your worker will perform asynchronous or not.

-
-
-

Default Value

false

- -

Deprecated

This option will be removed in the next major version.

-
-
- -
killBehavior?: "SOFT" | "HARD"
-

killBehavior dictates if your worker will be deleted in case a task is active on it.

+

Properties

killBehavior?: "SOFT" | "HARD"

killBehavior dictates if your worker will be deleted in case a task is active on it.

  • SOFT: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker won't be deleted.
  • HARD: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker will be deleted.

This option only apply to the newly created workers.

-
-
-

Default Value

KillBehaviors.SOFT

-
-
- -
killHandler?: KillHandler
-

The function to call when a worker is killed.

-
-
-
- -
maxInactiveTime?: number
-

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

+

Default Value

KillBehaviors.SOFT
+
+
killHandler?: KillHandler

The function to call when a worker is killed.

+

Default Value

() => {}

+
maxInactiveTime?: number

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.

    @@ -85,98 +20,6 @@ The last active time of your worker will be updated when it terminates a task.
  • 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

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Default Value

60000
+
+

Generated using TypeDoc

\ No newline at end of file