X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=d45702c700c59aa42e4d27ba45788f02cee42540;hb=8c6d4acf22398bf755be85612cf1e79f3dd5fbf7;hp=9662c29830f0f7e8c799029d2d4d2ada207d9f8f;hpb=6b83e544b1827a8a04898c3032dab73fe19687e6;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 9662c298..d45702c7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -36,7 +36,7 @@ ### `pool.execute(data, name, transferList)` `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'` +`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 This method is available on both pool implementations and returns a promise with the task function execution response.