X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=29ae73799858356f87d10d197e20c9c67a7fe9b5;hb=refs%2Ftags%2Fv3.1.4;hp=28282ac2314bc05322098d09ad5ad0d08a163595;hpb=b4e93467358d93166716dc6e5075d58c18c961c7;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 28282ac2..29ae7379 100644 --- a/docs/api.md +++ b/docs/api.md @@ -14,8 +14,6 @@ - [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames) - [`pool.setDefaultTaskFunction(name)`](#poolsetdefaulttaskfunctionname) - [`PoolOptions`](#pooloptions) - - [`ThreadPoolOptions extends PoolOptions`](#threadpooloptions-extends-pooloptions) - - [`ClusterPoolOptions extends PoolOptions`](#clusterpooloptions-extends-pooloptions) - [Worker](#worker) - [`class YourWorker extends ThreadWorker/ClusterWorker`](#class-yourworker-extends-threadworkerclusterworker) - [`YourWorker.hasTaskFunction(name)`](#yourworkerhastaskfunctionname) @@ -63,7 +61,7 @@ This method is available on both pool implementations and returns a boolean. ### `pool.addTaskFunction(name, fn)` -`name` (mandatory) The task function name. +`name` (mandatory) The task function name. `fn` (mandatory) The task function. This method is available on both pool implementations and returns a boolean promise. @@ -141,12 +139,8 @@ An object with these properties: Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true }` -#### `ThreadPoolOptions extends PoolOptions` - - `workerOptions` (optional) - An object with the worker options to pass to worker. See [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) for more details. -#### `ClusterPoolOptions extends PoolOptions` - - `env` (optional) - An object with the environment variables to pass to worker. See [cluster](https://nodejs.org/api/cluster.html#cluster_cluster_fork_env) for more details. - `settings` (optional) - An object with the cluster settings. See [cluster](https://nodejs.org/api/cluster.html#cluster_cluster_settings) for more details.