From: Jérôme Benoit Date: Thu, 7 Sep 2023 21:50:39 +0000 (+0200) Subject: docs: spell fixes X-Git-Tag: v2.6.43~11 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=a36b9e1ffde1c9a352156760f00333a747226650;p=poolifier.git docs: spell fixes Signed-off-by: Jérôme Benoit --- diff --git a/README.md b/README.md index 5f6662be..5ef41385 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ Please consult our [general guidelines](#general-guidelines). Poolifier contains two [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker)/[cluster](https://nodejs.org/api/cluster.html#cluster_class_worker) worker pool implementations, you don't have to deal with [worker_threads](https://nodejs.org/api/worker_threads.html)/[cluster](https://nodejs.org/api/cluster.html) complexity. The first implementation is a fixed worker pool, with a defined number of workers that are started at creation time and will be reused. -The second implementation is a dynamic worker pool, with a number of worker started at creation time (these workers will be always active and reused) and other workers created when the load will increase (with an upper limit, these workers will be reused when active), the new created workers will be stopped after a configurable period of inactivity. +The second implementation is a dynamic worker pool, with a number of worker started at creation time (these workers will be always active and reused) and other workers created when the load will increase (with an upper limit, these workers will be reused when active), the newly created workers will be stopped after a configurable period of inactivity. You have to implement your worker by extending the _ThreadWorker_ or _ClusterWorker_ class. ## Installation 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