From: Jérôme Benoit Date: Fri, 22 Dec 2023 14:56:35 +0000 (+0100) Subject: docs: refine API documentation X-Git-Tag: v3.1.10~4 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=31d7126774bba6e7c0793053f7635501cd88fa3f;p=poolifier.git docs: refine API documentation Signed-off-by: Jérôme Benoit --- diff --git a/docs/api.md b/docs/api.md index 1a881ba5..6eead0f7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -13,7 +13,7 @@ - [`pool.removeTaskFunction(name)`](#poolremovetaskfunctionname) - [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames) - [`pool.setDefaultTaskFunction(name)`](#poolsetdefaulttaskfunctionname) - - [`Pool options`](#pool-options) + - [Pool options](#pool-options) - [Worker](#worker) - [`class YourWorker extends ThreadWorker/ClusterWorker`](#class-yourworker-extends-threadworkerclusterworker) - [`YourWorker.hasTaskFunction(name)`](#yourworkerhastaskfunctionname) @@ -82,7 +82,7 @@ This method is available on both pool implementations and returns an array of th This method is available on both pool implementations and returns a boolean promise. -### `Pool options` +### Pool options An object with these properties: