X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=0713392631eda5f48a37719c1b07b055c6ce6db2;hb=a971ede64ed96dfc3ec345dd298acaf30cb477ee;hp=eda9ba74649888c8207de849bf56f108de297184;hpb=52589b47294bffa67444f0490c43476c95b19dc9;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index eda9ba74..07133926 100644 --- a/docs/api.md +++ b/docs/api.md @@ -30,7 +30,7 @@ ### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)` `min` (mandatory) Same as _FixedThreadPool_/_FixedClusterPool_ numberOfThreads/numberOfWorkers, this number of workers will be always active -`max` (mandatory) Max number of workers that this pool can contain, the new created workers will die after a threshold (default is 1 minute, you can override it in your worker implementation). +`max` (mandatory) Max number of workers that this pool can contain, the newly created workers will die after a threshold (default is 1 minute, you can override it in your worker implementation). `filePath` (mandatory) Path to a file with a worker implementation `opts` (optional) An object with the pool options properties described below