X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FWorkerOptions.html;h=f5c68efa1203344d90570bcac793ad360a8a7f60;hb=refs%2Fheads%2Fmaster;hp=2d7fd7cf3bd56f5793e9bf123a64e5e921628867;hpb=a7ee49b03e5a2ee6bd1a1b74a2fe3a2fb7c23404;p=poolifier.git diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 2d7fd7cf..238e4d64 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | poolifier - v4.0.16

Interface WorkerOptions

Options for workers.

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

Properties

killBehavior? +WorkerOptions | poolifier - v4.2.3

Interface WorkerOptions

Options for workers.

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

Properties

killBehavior? killHandler? maxInactiveTime?

Properties

OptionalkillBehavior

killBehavior?: "SOFT" | "HARD"

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

@@ -11,9 +11,9 @@

Default Value

KillBehaviors.SOFT
-

OptionalkillHandler

killHandler?: KillHandler

The function to call when a worker is killed.

+

OptionalkillHandler

killHandler?: KillHandler

The function to call when a worker is killed.

Default Value

() => {}

-

OptionalmaxInactiveTime

maxInactiveTime?: number

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

+

OptionalmaxInactiveTime

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.

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

Default Value

60000
-

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file +

Settings

Member Visibility

On This Page

Properties