From 5e5ea237b14d14484a9f5eb2d5ca8f01de546cfd Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sat, 10 Jun 2023 12:26:49 +0200 Subject: [PATCH] docs: refine README MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d3a4534f..6f94626a 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,7 @@ Node versions >= 16.14.x are supported. ## [API](https://poolifier.github.io/poolifier/) -### Pool options +### `PoolOptions` An object with these properties: @@ -196,11 +196,11 @@ An object with these properties: Default: `{ concurrency: 1 }` -#### Thread pool specific options +#### `ThreadPoolOptions` - `workerOptions` (optional) - An object with the worker options. See [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) for more details. -#### Cluster pool specific options +#### `ClusterPoolOptions` - `env` (optional) - An object with the environment variables to pass to the worker. See [cluster](https://nodejs.org/api/cluster.html#cluster_cluster_fork_env) for more details. -- 2.34.1