From 8c445a4e97379308fe9555c521818edcfdfac7ec Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sun, 17 Sep 2023 22:45:55 +0200 Subject: [PATCH] docs: refine docs/api.md MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- docs/api.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api.md b/docs/api.md index c8a135f1..df7d1ce5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -24,20 +24,20 @@ ### `pool = new FixedThreadPool/FixedClusterPool(numberOfThreads/numberOfWorkers, filePath, opts)` -`numberOfThreads/numberOfWorkers` (mandatory) Number of workers for this pool -`filePath` (mandatory) Path to a file with a worker implementation -`opts` (optional) An object with the pool options properties described below +`numberOfThreads/numberOfWorkers` (mandatory) Number of workers for this pool. +`filePath` (mandatory) Path to a file with a worker implementation. +`opts` (optional) An object with the pool options properties described below. ### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)` -`min` (mandatory) Same as _FixedThreadPool_/_FixedClusterPool_ numberOfThreads/numberOfWorkers, this number of workers will be always active +`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 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 +`filePath` (mandatory) Path to a file with a worker implementation. +`opts` (optional) An object with the pool options properties described below. ### `pool.execute(data, name, transferList)` -`data` (optional) An object that you want to pass to your worker implementation +`data` (optional) An object that you want to pass to your worker implementation. `name` (optional) A string with the task function name that you want to execute on the worker. Default: `'default'` `transferList` (optional) An array of transferable objects that you want to transfer to your [worker_threads](https://nodejs.org/api/worker_threads.html) worker implementation @@ -126,7 +126,7 @@ An object with these properties: ### `class YourWorker extends ThreadWorker/ClusterWorker` -`taskFunctions` (mandatory) The task function or task functions object `{ name_1: fn_1, ..., name_n: fn_n }` that you want to execute on the worker +`taskFunctions` (mandatory) The task function or task functions object `{ name_1: fn_1, ..., name_n: fn_n }` that you want to execute on the worker. `opts` (optional) An object with these properties: - `killBehavior` (optional) - Dictates if your worker will be deleted in case a task is active on it. @@ -146,20 +146,20 @@ An object with these properties: #### `YourWorker.hasTaskFunction(name)` -`name` (mandatory) The task function name +`name` (mandatory) The task function name. This method is available on both worker implementations and returns a boolean. #### `YourWorker.addTaskFunction(name, fn)` -`name` (mandatory) The task function name -`fn` (mandatory) The task function +`name` (mandatory) The task function name. +`fn` (mandatory) The task function. This method is available on both worker implementations and returns a boolean. #### `YourWorker.removeTaskFunction(name)` -`name` (mandatory) The task function name +`name` (mandatory) The task function name. This method is available on both worker implementations and returns a boolean. @@ -169,6 +169,6 @@ This method is available on both worker implementations and returns an array of #### `YourWorker.setDefaultTaskFunction(name)` -`name` (mandatory) The task function name +`name` (mandatory) The task function name. This method is available on both worker implementations and returns a boolean. -- 2.34.1