@twin.org/background-task-scheduler 0.0.3-next.4 → 0.0.3-next.5

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Background Task Scheduler
 
-Schedule background tasks to run at a specific interval or time.
+This package is part of the background task toolkit and helps build reliable asynchronous workflows in TWIN applications.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.5](https://github.com/twinfoundation/background-task/compare/background-task-scheduler-v0.0.3-next.4...background-task-scheduler-v0.0.3-next.5) (2026-04-10)
+
+
+### Miscellaneous Chores
+
+* **background-task-scheduler:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/background-task-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
 ## [0.0.3-next.4](https://github.com/twinfoundation/background-task/compare/background-task-scheduler-v0.0.3-next.3...background-task-scheduler-v0.0.3-next.4) (2026-02-23)
 
 
@@ -269,4 +283,4 @@
   * dependencies
     * @twin.org/background-task-models bumped from 0.0.1-next.18 to 0.0.1-next.19
 
-## @twin.org/background-task-scheduler - Changelog
+## Changelog

package/docs/examples.md

@@ -1 +1,95 @@
-# @twin.org/background-task-scheduler - Examples
+# Background Task Scheduler Examples
+
+Use these snippets to configure recurring schedules and monitor trigger state for background work.
+
+## TaskSchedulerService
+
+```typescript
+import { TaskSchedulerService } from '@twin.org/background-task-scheduler';
+
+const scheduler = new TaskSchedulerService({
+  config: {
+    intervalMs: 10000,
+    stalledTaskTimeoutMs: 120000
+  }
+});
+
+console.log(scheduler.className()); // TaskSchedulerService
+```
+
+```typescript
+import { TaskSchedulerService } from '@twin.org/background-task-scheduler';
+
+const scheduler = new TaskSchedulerService();
+const taskId = 'report-refresh';
+
+await scheduler.addTask(
+  taskId,
+  [
+    {
+      nextTriggerTime: Date.now() + 5000,
+      intervalMinutes: 10
+    },
+    {
+      nextTriggerTime: Date.now() + 30000,
+      intervalHours: 1
+    }
+  ],
+  async () => {
+    const runAt = new Date().toISOString();
+    console.log('report-refresh runAt', runAt); // report-refresh runAt 2026-03-09T10:45:05.000Z
+  }
+);
+
+const info = await scheduler.tasksInfo();
+console.log(info.tasks[taskId].length); // 2
+```
+
+```typescript
+import { TaskSchedulerService } from '@twin.org/background-task-scheduler';
+
+const scheduler = new TaskSchedulerService();
+const taskId = 'cache-prune';
+
+await scheduler.addTask(
+  taskId,
+  [
+    {
+      nextTriggerTime: Date.now() + 1000,
+      intervalMinutes: 5
+    }
+  ],
+  async () => {
+    const runAt = new Date().toISOString();
+    console.log('cache-prune runAt', runAt); // cache-prune runAt 2026-03-09T10:45:01.000Z
+  }
+);
+
+await scheduler.removeTask(taskId);
+
+const infoAfterRemoval = await scheduler.tasksInfo();
+console.log(taskId in infoAfterRemoval.tasks); // false
+
+await scheduler.stop();
+```
+
+## ScheduledTask
+
+```typescript
+import { ScheduledTask } from '@twin.org/background-task-scheduler';
+
+const scheduledTask = new ScheduledTask();
+scheduledTask.id = 'nightly-index';
+scheduledTask.lastRunTime = Date.now();
+
+console.log(scheduledTask.id); // nightly-index
+console.log(typeof scheduledTask.lastRunTime); // number
+```
+
+## initSchema
+
+```typescript
+import { initSchema } from '@twin.org/background-task-scheduler';
+
+initSchema();
+```

package/docs/reference/classes/ScheduledTask.md

@@ -14,7 +14,7 @@ Class defining a scheduled task.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,8 +22,8 @@ The id.
 
 ***
 
-### lastRunTime?
+### lastRunTime? {#lastruntime}
 
-> `optional` **lastRunTime**: `number`
+> `optional` **lastRunTime?**: `number`
 
 The last run time of the task, if undefined waiting for next run.

package/docs/reference/classes/TaskSchedulerService.md

@@ -28,7 +28,7 @@ The options for the scheduler.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
@@ -80,7 +80,7 @@ Nothing.
 
 ***
 
-### addTask()
+### addTask() {#addtask}
 
 > **addTask**(`taskId`, `times`, `taskCallback`): `Promise`\<`void`\>
 
@@ -118,7 +118,7 @@ Nothing.
 
 ***
 
-### removeTask()
+### removeTask() {#removetask}
 
 > **removeTask**(`taskId`): `Promise`\<`void`\>
 
@@ -144,7 +144,7 @@ Nothing.
 
 ***
 
-### tasksInfo()
+### tasksInfo() {#tasksinfo}
 
 > **tasksInfo**(): `Promise`\<`IScheduledTaskInfo`\>
 

package/docs/reference/interfaces/ITaskSchedulerConfig.md

@@ -4,9 +4,9 @@ Interface for the task scheduler configuration.
 
 ## Properties
 
-### intervalMs?
+### intervalMs? {#intervalms}
 
-> `optional` **intervalMs**: `number`
+> `optional` **intervalMs?**: `number`
 
 The interval between checks for running tasks, defaults to 1 minute since that is the resolution of the tasks.
 
@@ -18,9 +18,9 @@ The interval between checks for running tasks, defaults to 1 minute since that i
 
 ***
 
-### stalledTaskTimeoutMs?
+### stalledTaskTimeoutMs? {#stalledtasktimeoutms}
 
-> `optional` **stalledTaskTimeoutMs**: `number`
+> `optional` **stalledTaskTimeoutMs?**: `number`
 
 The time in milliseconds after which a task that is still marked as running is considered stalled and can be run again.
 

package/docs/reference/interfaces/ITaskSchedulerConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the task scheduler constructor.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The logging component type.
 
@@ -18,9 +18,9 @@ logging
 
 ***
 
-### scheduledTaskEntityStorageType?
+### scheduledTaskEntityStorageType? {#scheduledtaskentitystoragetype}
 
-> `optional` **scheduledTaskEntityStorageType**: `string`
+> `optional` **scheduledTaskEntityStorageType?**: `string`
 
 The scheduled task entity storage connector type.
 
@@ -32,8 +32,8 @@ scheduled-task
 
 ***
 
-### config?
+### config? {#config}
 
-> `optional` **config**: [`ITaskSchedulerConfig`](ITaskSchedulerConfig.md)
+> `optional` **config?**: [`ITaskSchedulerConfig`](ITaskSchedulerConfig.md)
 
 The configuration for the task scheduler.

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/background-task-scheduler",
-	"version": "0.0.3-next.4",
-	"description": "Background task scheduler",
+	"version": "0.0.3-next.5",
+	"description": "Schedules background tasks for one-off or recurring execution windows",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/background-task.git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/background-task-models": "0.0.3-next.4",
+		"@twin.org/background-task-models": "0.0.3-next.5",
 		"@twin.org/core": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/logging-models": "next",