refactor: stricter worker constructor arguments check

[poolifier.git] / docs / api.md

diff --git a/docs/api.md b/docs/api.md
index 7939123b1e64b0bcbe5c75103aeb3f93a47ba830..c8a135f150d75b441216546b1cb0fa3c0e7bd95c 100644 (file)
--- a/docs/api.md
+++ b/docs/api.md
@@ -135,7 +135,7 @@ An object with these properties:
   This option only apply to the newly created workers.  
   Default: `KillBehaviors.SOFT`
 
-- `maxInactiveTime` (optional) - Maximum waiting time in milliseconds for tasks on newly created workers. After this time newly created workers will die.  
+- `maxInactiveTime` (optional) - Maximum waiting time in milliseconds for tasks on newly created workers. After this time newly created workers will die. It must be a positive integer greater or equal than 5.  
   The last active time of your worker will be updated when it terminates a task.  
   If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool, when this timeout expires your tasks is interrupted before completion and removed. The worker is killed if is not part of the minimum size of the pool.  
   If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.