X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=ad8ede83926db63389c9f8640d3036bc99815703;hb=e9dd5b668e17caa64fe1e3e17f481b36a42dffb3;hp=eda9ba74649888c8207de849bf56f108de297184;hpb=bde1a004f39c24f58e8ad41974ea4fb0a6b32f4e;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index eda9ba74..ad8ede83 100644 --- a/docs/api.md +++ b/docs/api.md @@ -7,7 +7,7 @@ - [`pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`](#pool--new-dynamicthreadpooldynamicclusterpoolmin-max-filepath-opts) - [`pool.execute(data, name, transferList)`](#poolexecutedata-name-transferlist) - [`pool.destroy()`](#pooldestroy) - - [`pool.listTaskFunctions()`](#poollisttaskfunctions) + - [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames) - [`PoolOptions`](#pooloptions) - [`ThreadPoolOptions extends PoolOptions`](#threadpooloptions-extends-pooloptions) - [`ClusterPoolOptions extends PoolOptions`](#clusterpooloptions-extends-pooloptions) @@ -16,7 +16,7 @@ - [`YourWorker.hasTaskFunction(name)`](#yourworkerhastaskfunctionname) - [`YourWorker.addTaskFunction(name, fn)`](#yourworkeraddtaskfunctionname-fn) - [`YourWorker.removeTaskFunction(name)`](#yourworkerremovetaskfunctionname) - - [`YourWorker.listTaskFunctions()`](#yourworkerlisttaskfunctions) + - [`YourWorker.listTaskFunctionNames()`](#yourworkerlisttaskfunctionnames) - [`YourWorker.setDefaultTaskFunction(name)`](#yourworkersetdefaulttaskfunctionname) ## Pool @@ -30,7 +30,7 @@ ### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)` `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 new created workers will die after a threshold (default is 1 minute, you can override it in your worker implementation). +`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 @@ -46,7 +46,7 @@ This method is available on both pool implementations and returns a promise with This method is available on both pool implementations and will call the terminate method on each worker. -### `pool.listTaskFunctions()` +### `pool.listTaskFunctionNames()` This method is available on both pool implementations and returns an array of the task function names. @@ -149,7 +149,7 @@ This method is available on both worker implementations and returns a boolean. This method is available on both worker implementations and returns a boolean. -#### `YourWorker.listTaskFunctions()` +#### `YourWorker.listTaskFunctionNames()` This method is available on both worker implementations and returns an array of the task function names.