@twin.org/background-task-models 0.0.1-next.4 → 0.0.1-next.5

package/dist/types/models/IBackgroundTaskConnector.d.ts

@@ -11,9 +11,10 @@ export interface IBackgroundTaskConnector extends IComponent {
      * @param taskType The type of the task the handler can process.
      * @param module The module the handler is in.
      * @param method The method in the module to execute.
+     * @param stateChangeCallback The callback to execute when the task state is updated.
      * @returns Nothing.
      */
-    registerHandler(taskType: string, module: string, method: string): Promise<void>;
+    registerHandler<T, U>(taskType: string, module: string, method: string, stateChangeCallback?: (task: IBackgroundTask<T, U>) => Promise<void>): Promise<void>;
     /**
      * Unregister a handler for a task.
      * @param taskType The type of the task handler to remove.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/background-task-models - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.5
 
 - Initial Release

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -10,10 +10,16 @@ Interface describing a background task connector.
 
 ### registerHandler()
 
-> **registerHandler**(`taskType`, `module`, `method`): `Promise`\<`void`\>
+> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback`?): `Promise`\<`void`\>
 
 Register a handler for a task.
 
+#### Type Parameters
+
+• **T**
+
+• **U**
+
 #### Parameters
 
 • **taskType**: `string`
@@ -28,6 +34,10 @@ The module the handler is in.
 
 The method in the module to execute.
 
+• **stateChangeCallback?**
+
+The callback to execute when the task state is updated.
+
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.1-next.4",
+	"version": "0.0.1-next.5",
 	"description": "Models which define the structure of the background task contracts and connectors",
 	"repository": {
 		"type": "git",