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

package/dist/types/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./factories/backgroundTaskConnectorFactory";
-export * from "./models/backgroundTaskHandler";
 export * from "./models/IBackgroundTask";
 export * from "./models/IBackgroundTaskConnector";
 export * from "./models/taskStatus";

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

@@ -1,6 +1,5 @@
 import type { IComponent } from "@twin.org/core";
 import type { SortDirection } from "@twin.org/entity";
-import type { BackgroundTaskHandler } from "./backgroundTaskHandler";
 import type { IBackgroundTask } from "./IBackgroundTask";
 import type { TaskStatus } from "./taskStatus";
 /**
@@ -10,10 +9,12 @@ export interface IBackgroundTaskConnector extends IComponent {
     /**
      * Register a handler for a task.
      * @param taskType The type of the task the handler can process.
-     * @param handler The handler for the task.
+     * @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<T, U>(taskType: string, handler: BackgroundTaskHandler<T, U>): 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.3
+## v0.0.1-next.5
 
 - Initial Release

package/docs/reference/index.md

@@ -7,7 +7,6 @@
 
 ## Type Aliases
 
-- [BackgroundTaskHandler](type-aliases/BackgroundTaskHandler.md)
 - [TaskStatus](type-aliases/TaskStatus.md)
 
 ## Variables

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -10,7 +10,7 @@ Interface describing a background task connector.
 
 ### registerHandler()
 
-> **registerHandler**\<`T`, `U`\>(`taskType`, `handler`): `Promise`\<`void`\>
+> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback`?): `Promise`\<`void`\>
 
 Register a handler for a task.
 
@@ -26,9 +26,17 @@ Register a handler for a task.
 
 The type of the task the handler can process.
 
-• **handler**: [`BackgroundTaskHandler`](../type-aliases/BackgroundTaskHandler.md)\<`T`, `U`\>
+• **module**: `string`
 
-The handler for the task.
+The module the handler is in.
+
+• **method**: `string`
+
+The method in the module to execute.
+
+• **stateChangeCallback?**
+
+The callback to execute when the task state is updated.
 
 #### Returns
 

package/package.json

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

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

@@ -1,4 +0,0 @@
-/**
- * Interface describing a task handler, exceptions thrown in the handler will be caught.
- */
-export type BackgroundTaskHandler<T = any, U = any> = (payload: T) => Promise<U>;

package/docs/reference/type-aliases/BackgroundTaskHandler.md

@@ -1,19 +0,0 @@
-# Type Alias: BackgroundTaskHandler()\<T, U\>
-
-> **BackgroundTaskHandler**\<`T`, `U`\>: (`payload`) => `Promise`\<`U`\>
-
-Interface describing a task handler, exceptions thrown in the handler will be caught.
-
-## Type Parameters
-
-• **T** = `any`
-
-• **U** = `any`
-
-## Parameters
-
-• **payload**: `T`
-
-## Returns
-
-`Promise`\<`U`\>