X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=d76c5672739ec1aebeb9eac5e8c10ff87716944b;hb=061c73fe2b7d67ed9f106557bc058b3ed80f1163;hp=846702e32911ab81d45f844498c0ed7d15a7d606;hpb=88499cf9c298c12aa8235e60d27657f50d3c38ee;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 846702e3..d76c5672 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,74 +1,18 @@ -
Options for workers.
+Optional
asyncWhether your worker will perform asynchronous or not.
-false
- -This option will be removed in the next major version.
-Optional
killkillBehavior
dictates if your worker will be deleted in case a task is active on it.
Optional
killkillBehavior
dictates if your worker will be deleted in case a task is active on it.
currentTime - lastActiveTime
is greater than maxInactiveTime
but a task is still executing or queued, then the worker won't be deleted.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.
-KillBehaviors.SOFT
-Optional
maxMaximum waiting time in milliseconds for tasks on newly created workers.
+KillBehaviors.SOFT
+
+Optional
killThe function to call when a worker is killed.
+() => {}
Optional
maxMaximum 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.
killBehavior
is set to KillBehaviors.SOFT
your tasks have no timeout and your workers will not be terminated until your task is completed.60000
-Generated using TypeDoc
60000
+
+Generated using TypeDoc
Options for workers.
-