Merge branch 'master' into feature/task-functions
authorJérôme Benoit <jerome.benoit@sap.com>
Sun, 17 Sep 2023 20:47:48 +0000 (22:47 +0200)
committerGitHub <noreply@github.com>
Sun, 17 Sep 2023 20:47:48 +0000 (22:47 +0200)
1  2 
docs/api.md

diff --cc docs/api.md
index d2cc2ba7747c31f7bdf0b0efbc204ae29919639d,df7d1ce5c1fa63def41ccbedbd1522f19c350aca..15760676c1f23e38518a5f19cece8f03308f5b05
@@@ -152,29 -146,29 +152,29 @@@ An object with these properties
  
  #### `YourWorker.hasTaskFunction(name)`
  
- `name` (mandatory) The task function name
+ `name` (mandatory) The task function name.
  
 -This method is available on both worker implementations and returns a boolean.
 +This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
  
  #### `YourWorker.addTaskFunction(name, fn)`
  
- `name` (mandatory) The task function name  
- `fn` (mandatory) The task function
+ `name` (mandatory) The task function name.  
+ `fn` (mandatory) The task function.
  
 -This method is available on both worker implementations and returns a boolean.
 +This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
  
  #### `YourWorker.removeTaskFunction(name)`
  
- `name` (mandatory) The task function name
+ `name` (mandatory) The task function name.
  
 -This method is available on both worker implementations and returns a boolean.
 +This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.
  
 -#### `YourWorker.listTaskFunctions()`
 +#### `YourWorker.listTaskFunctionNames()`
  
  This method is available on both worker implementations and returns an array of the task function names.
  
  #### `YourWorker.setDefaultTaskFunction(name)`
  
- `name` (mandatory) The task function name
+ `name` (mandatory) The task function name.
  
 -This method is available on both worker implementations and returns a boolean.
 +This method is available on both worker implementations and returns `{ status: boolean, error?: Error }`.