UNPKG

@nexim/task-scheduler

Version:

A TypeScript task scheduler with persistence and conditional execution.

github.com/the-nexim/nanolib/tree/next/packages/task-scheduler

the-nexim/nanolib

74 lines (42 loc) • 1.92 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
[@nexim/task-scheduler](../README.md) / TaskScheduler # Class: TaskScheduler Manages scheduled tasks with persistence and conditional execution ## Constructors ### Constructor > **new TaskScheduler**(): `TaskScheduler` #### Returns `TaskScheduler` ## Methods ### addTask() > **addTask**(`id`: `string`, `fn`: () => `void` \| `Promise`\<`void`\>, `interval`: `Duration`, `options?`: [`TaskOptions`](../interfaces/TaskOptions.md)): `void` Adds a new scheduled task #### Parameters | Parameter | Type | Description | | ---------- | --------------------------------------------- | ------------------------------------- | | `id` | `string` | Unique task identifier | | `fn` | () => `void` \| `Promise`\<`void`\> | Function to execute | | `interval` | `Duration` | Execution interval (e.g., '5m', '1h') | | `options?` | [`TaskOptions`](../interfaces/TaskOptions.md) | Additional task options | #### Returns `void` --- ### removeTask() > **removeTask**(`id`: `string`): `void` Removes a task from the scheduler #### Parameters | Parameter | Type | Description | | --------- | -------- | ------------------------- | | `id` | `string` | Task identifier to remove | #### Returns `void` --- ### updateLastRun() > **updateLastRun**(`id`: `string`, `timestamp`: `number`): `void` Updates the last run timestamp for a task (useful for external trigger tasks) #### Parameters | Parameter | Type | Description | | ----------- | -------- | ---------------------------------------- | | `id` | `string` | Task identifier | | `timestamp` | `number` | New last run timestamp (defaults to now) | #### Returns `void`