@twin.org/background-task-models 0.0.1-next.13 → 0.0.1-next.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/background-task-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.1-next.15](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.14...background-task-models-v0.0.1-next.15) (2025-04-17)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
|
|
9
|
+
|
|
10
|
+
## [0.0.1-next.14](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.13...background-task-models-v0.0.1-next.14) (2025-04-11)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Miscellaneous Chores
|
|
14
|
+
|
|
15
|
+
* **background-task-models:** Synchronize repo versions
|
|
16
|
+
|
|
3
17
|
## [0.0.1-next.13](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.12...background-task-models-v0.0.1-next.13) (2025-03-28)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -10,15 +10,19 @@ Interface describing a background task connector.
|
|
|
10
10
|
|
|
11
11
|
### registerHandler()
|
|
12
12
|
|
|
13
|
-
> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback
|
|
13
|
+
> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback?`): `Promise`\<`void`\>
|
|
14
14
|
|
|
15
15
|
Register a handler for a task.
|
|
16
16
|
|
|
17
17
|
#### Type Parameters
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
##### T
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
`T`
|
|
22
|
+
|
|
23
|
+
##### U
|
|
24
|
+
|
|
25
|
+
`U`
|
|
22
26
|
|
|
23
27
|
#### Parameters
|
|
24
28
|
|
|
@@ -78,13 +82,15 @@ Nothing.
|
|
|
78
82
|
|
|
79
83
|
### create()
|
|
80
84
|
|
|
81
|
-
> **create**\<`T`\>(`type`, `payload
|
|
85
|
+
> **create**\<`T`\>(`type`, `payload?`, `options?`): `Promise`\<`string`\>
|
|
82
86
|
|
|
83
87
|
Create a new task.
|
|
84
88
|
|
|
85
89
|
#### Type Parameters
|
|
86
90
|
|
|
87
|
-
|
|
91
|
+
##### T
|
|
92
|
+
|
|
93
|
+
`T`
|
|
88
94
|
|
|
89
95
|
#### Parameters
|
|
90
96
|
|
|
@@ -138,9 +144,13 @@ Get the task details.
|
|
|
138
144
|
|
|
139
145
|
#### Type Parameters
|
|
140
146
|
|
|
141
|
-
|
|
147
|
+
##### T
|
|
148
|
+
|
|
149
|
+
`T`
|
|
150
|
+
|
|
151
|
+
##### U
|
|
142
152
|
|
|
143
|
-
|
|
153
|
+
`U`
|
|
144
154
|
|
|
145
155
|
#### Parameters
|
|
146
156
|
|
|
@@ -226,7 +236,7 @@ Nothing.
|
|
|
226
236
|
|
|
227
237
|
### query()
|
|
228
238
|
|
|
229
|
-
> **query**(`taskType
|
|
239
|
+
> **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor`: `string`; \}\>
|
|
230
240
|
|
|
231
241
|
Get a list of tasks.
|
|
232
242
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: TaskStatus
|
|
2
2
|
|
|
3
|
-
> **TaskStatus
|
|
3
|
+
> **TaskStatus** = *typeof* [`TaskStatus`](../variables/TaskStatus.md)\[keyof *typeof* [`TaskStatus`](../variables/TaskStatus.md)\]
|
|
4
4
|
|
|
5
5
|
Task statuses.
|
package/package.json
CHANGED