Merge dependabot/npm_and_yarn/examples/typescript/http-server-pool/fastify-hybrid...

[poolifier.git] / docs / api.md

diff --git a/docs/api.md b/docs/api.md
index bd5ace7a7cc19df75d509e0c7bcf722a7a14f095..5e4eeb227ff12b5d2c894f952ca6435d66cc0418 100644 (file)
--- a/docs/api.md
+++ b/docs/api.md
@@ -13,7 +13,7 @@
   - [`pool.removeTaskFunction(name)`](#poolremovetaskfunctionname)
   - [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames)
   - [`pool.setDefaultTaskFunction(name)`](#poolsetdefaulttaskfunctionname)
-  - [`PoolOptions`](#pooloptions)
+  - [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.
 
-### `PoolOptions`
+### Pool options
 
 An object with these properties:
 
@@ -123,7 +123,7 @@ An object with these properties:
   Default: `true`
 - `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool.  
   Default: `true`
-- `enableEvents` (optional) - Events integrated with async resource emission enablement in this pool.  
+- `enableEvents` (optional) - Pool events integrated with async resource emission enablement.  
   Default: `true`
 - `enableTasksQueue` (optional) - Tasks queue per worker enablement in this pool.  
   Default: `false`