X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=0a13927586a9dd17c97d9925fce2fe77e4d9ef45;hb=b91134ce1c0d673b62091e945a1271d08749af55;hp=28282ac2314bc05322098d09ad5ad0d08a163595;hpb=65542a35fd6759cddb82167dd4c47f9bed843ebf;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 28282ac2..0a139275 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) @@ -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.