X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=8e3c77076f231bda67064b51eba22cd4150c3d77;hb=103057eedf4f7b18f009333806d0293bfb23e204;hp=15760676c1f23e38518a5f19cece8f03308f5b05;hpb=29dc485a322ff057eea10d8b874b6f292bda7ff5;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 15760676..8e3c7707 100644 --- a/docs/api.md +++ b/docs/api.md @@ -8,7 +8,11 @@ - [`pool.execute(data, name, transferList)`](#poolexecutedata-name-transferlist) - [`pool.start()`](#poolstart) - [`pool.destroy()`](#pooldestroy) + - [`pool.hasTaskFunction(name)`](#poolhastaskfunctionname) + - [`pool.addTaskFunction(name, fn)`](#pooladdtaskfunctionname-fn) + - [`pool.removeTaskFunction(name)`](#poolremovetaskfunctionname) - [`pool.listTaskFunctionNames()`](#poollisttaskfunctionnames) + - [`pool.setDefaultTaskFunction(name)`](#poolsetdefaulttaskfunctionname) - [`PoolOptions`](#pooloptions) - [`ThreadPoolOptions extends PoolOptions`](#threadpooloptions-extends-pooloptions) - [`ClusterPoolOptions extends PoolOptions`](#clusterpooloptions-extends-pooloptions) @@ -39,7 +43,7 @@ `data` (optional) An object that you want to pass to your worker implementation. `name` (optional) A string with the task function name that you want to execute on the worker. Default: `'default'` -`transferList` (optional) An array of transferable objects that you want to transfer to your [worker_threads](https://nodejs.org/api/worker_threads.html) worker implementation +`transferList` (optional) An array of transferable objects that you want to transfer to your [worker_threads](https://nodejs.org/api/worker_threads.html) worker implementation. This method is available on both pool implementations and returns a promise with the task function execution response. @@ -53,14 +57,33 @@ This method is available on both pool implementations and will call the terminat ### `pool.hasTaskFunction(name)` -`name` (mandatory) The task function name +`name` (mandatory) The task function name. This method is available on both pool implementations and returns a boolean. +### `pool.addTaskFunction(name, fn)` + +`name` (mandatory) The task function name. +`fn` (mandatory) The task function. + +This method is available on both pool implementations and returns a boolean promise. + +### `pool.removeTaskFunction(name)` + +`name` (mandatory) The task function name. + +This method is available on both pool implementations and returns a boolean promise. + ### `pool.listTaskFunctionNames()` This method is available on both pool implementations and returns an array of the task function names. +### `pool.setDefaultTaskFunction(name)` + +`name` (mandatory) The task function name. + +This method is available on both pool implementations and returns a boolean promise. + ### `PoolOptions` An object with these properties: