eternal-timer 2.3.0 → 2.4.0

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.
Files changed (86) hide show
  1. package/README.md +25 -13
  2. package/dist/cjs/TimersManager/JSONLTimersManager.cjs +25 -0
  3. package/dist/cjs/TimersManager/JSONLTimersManager.cjs.map +1 -0
  4. package/dist/cjs/TimersManager/JSONLTimersManager.d.ts +18 -0
  5. package/dist/cjs/TimersManager/JSONLTimersManager.d.ts.map +1 -0
  6. package/dist/cjs/TimersManager/PlainTextTimersManager.cjs +25 -0
  7. package/dist/cjs/TimersManager/PlainTextTimersManager.cjs.map +1 -0
  8. package/dist/cjs/TimersManager/PlainTextTimersManager.d.ts +18 -0
  9. package/dist/cjs/TimersManager/PlainTextTimersManager.d.ts.map +1 -0
  10. package/dist/cjs/TimersManager/TimersManager.cjs +211 -0
  11. package/dist/cjs/TimersManager/TimersManager.cjs.map +1 -0
  12. package/dist/cjs/TimersManager/TimersManager.d.ts +87 -0
  13. package/dist/cjs/TimersManager/TimersManager.d.ts.map +1 -0
  14. package/dist/cjs/TimersStore/JSONLTimersStore.cjs +50 -0
  15. package/dist/cjs/TimersStore/JSONLTimersStore.cjs.map +1 -0
  16. package/dist/cjs/TimersStore/JSONLTimersStore.d.ts +16 -0
  17. package/dist/cjs/TimersStore/JSONLTimersStore.d.ts.map +1 -0
  18. package/dist/cjs/TimersStore/PlainTextTimersStore.cjs +56 -0
  19. package/dist/cjs/TimersStore/PlainTextTimersStore.cjs.map +1 -0
  20. package/dist/cjs/TimersStore/PlainTextTimersStore.d.ts +16 -0
  21. package/dist/cjs/TimersStore/PlainTextTimersStore.d.ts.map +1 -0
  22. package/dist/cjs/TimersStore/TimersStore.cjs +44 -0
  23. package/dist/cjs/TimersStore/TimersStore.cjs.map +1 -0
  24. package/dist/cjs/TimersStore/TimersStore.d.ts +12 -0
  25. package/dist/cjs/TimersStore/TimersStore.d.ts.map +1 -0
  26. package/dist/cjs/index.cjs +2 -2
  27. package/dist/cjs/index.cjs.map +1 -1
  28. package/dist/cjs/index.d.ts +2 -2
  29. package/dist/cjs/index.d.ts.map +1 -1
  30. package/dist/cjs/types.d.ts +6 -3
  31. package/dist/cjs/types.d.ts.map +1 -1
  32. package/dist/esm/TimersManager/JSONLTimersManager.d.ts +18 -0
  33. package/dist/esm/TimersManager/JSONLTimersManager.d.ts.map +1 -0
  34. package/dist/esm/TimersManager/JSONLTimersManager.js +21 -0
  35. package/dist/esm/TimersManager/JSONLTimersManager.js.map +1 -0
  36. package/dist/esm/TimersManager/PlainTextTimersManager.d.ts +18 -0
  37. package/dist/esm/TimersManager/PlainTextTimersManager.d.ts.map +1 -0
  38. package/dist/esm/TimersManager/PlainTextTimersManager.js +21 -0
  39. package/dist/esm/TimersManager/PlainTextTimersManager.js.map +1 -0
  40. package/dist/esm/TimersManager/TimersManager.d.ts +87 -0
  41. package/dist/esm/TimersManager/TimersManager.d.ts.map +1 -0
  42. package/dist/esm/TimersManager/TimersManager.js +205 -0
  43. package/dist/esm/TimersManager/TimersManager.js.map +1 -0
  44. package/dist/esm/TimersStore/JSONLTimersStore.d.ts +16 -0
  45. package/dist/esm/TimersStore/JSONLTimersStore.d.ts.map +1 -0
  46. package/dist/esm/TimersStore/JSONLTimersStore.js +46 -0
  47. package/dist/esm/TimersStore/JSONLTimersStore.js.map +1 -0
  48. package/dist/esm/TimersStore/PlainTextTimersStore.d.ts +16 -0
  49. package/dist/esm/TimersStore/PlainTextTimersStore.d.ts.map +1 -0
  50. package/dist/esm/TimersStore/PlainTextTimersStore.js +52 -0
  51. package/dist/esm/TimersStore/PlainTextTimersStore.js.map +1 -0
  52. package/dist/esm/TimersStore/TimersStore.d.ts +12 -0
  53. package/dist/esm/TimersStore/TimersStore.d.ts.map +1 -0
  54. package/dist/esm/TimersStore/TimersStore.js +37 -0
  55. package/dist/esm/TimersStore/TimersStore.js.map +1 -0
  56. package/dist/esm/index.d.ts +2 -2
  57. package/dist/esm/index.d.ts.map +1 -1
  58. package/dist/esm/index.js +2 -2
  59. package/dist/esm/index.js.map +1 -1
  60. package/dist/esm/types.d.ts +6 -3
  61. package/dist/esm/types.d.ts.map +1 -1
  62. package/package.json +1 -1
  63. package/dist/cjs/JSONLTimersManager.cjs +0 -199
  64. package/dist/cjs/JSONLTimersManager.cjs.map +0 -1
  65. package/dist/cjs/JSONLTimersManager.d.ts +0 -63
  66. package/dist/cjs/JSONLTimersManager.d.ts.map +0 -1
  67. package/dist/cjs/PlainTextTimersManager.cjs +0 -200
  68. package/dist/cjs/PlainTextTimersManager.cjs.map +0 -1
  69. package/dist/cjs/PlainTextTimersManager.d.ts +0 -60
  70. package/dist/cjs/PlainTextTimersManager.d.ts.map +0 -1
  71. package/dist/cjs/TimersManager.cjs +0 -39
  72. package/dist/cjs/TimersManager.cjs.map +0 -1
  73. package/dist/cjs/TimersManager.d.ts +0 -75
  74. package/dist/cjs/TimersManager.d.ts.map +0 -1
  75. package/dist/esm/JSONLTimersManager.d.ts +0 -63
  76. package/dist/esm/JSONLTimersManager.d.ts.map +0 -1
  77. package/dist/esm/JSONLTimersManager.js +0 -192
  78. package/dist/esm/JSONLTimersManager.js.map +0 -1
  79. package/dist/esm/PlainTextTimersManager.d.ts +0 -60
  80. package/dist/esm/PlainTextTimersManager.d.ts.map +0 -1
  81. package/dist/esm/PlainTextTimersManager.js +0 -193
  82. package/dist/esm/PlainTextTimersManager.js.map +0 -1
  83. package/dist/esm/TimersManager.d.ts +0 -75
  84. package/dist/esm/TimersManager.d.ts.map +0 -1
  85. package/dist/esm/TimersManager.js +0 -32
  86. package/dist/esm/TimersManager.js.map +0 -1
@@ -1,193 +0,0 @@
1
- import fs from "fs";
2
- import { v4 as uuidv4 } from "uuid";
3
- import readline from "readline";
4
- import { TimersManager } from "./TimersManager.js";
5
- import { Log } from "./Log.js";
6
- export class PlainTextTimersManager extends TimersManager {
7
- getDefaultFilename() {
8
- return ".timers";
9
- }
10
- /**
11
- * checkTimerfileSyntax
12
- * @description Checks the syntax of the timer file.
13
- * @param fileData
14
- * @returns void
15
- * @throws If syntax is invalid
16
- */
17
- async checkTimerfileSyntax(fileData) {
18
- const throwing = () => {
19
- throw new Error(`Timer file's syntax is wrong`);
20
- };
21
- const timersData = fileData
22
- .split('\n')
23
- .map(l => l.trim())
24
- .filter(l => l !== "");
25
- for (const timerData of timersData) {
26
- const timerArray = timerData.split(/\s+/);
27
- if (timerArray.length !== 3)
28
- throwing();
29
- if (timerArray[0]?.length !== 36)
30
- throwing();
31
- if (timerArray[1].trim() === "")
32
- throwing();
33
- if (timerArray[2].trim() === "")
34
- throwing();
35
- }
36
- return;
37
- }
38
- /**
39
- * createTimer
40
- * @description Creates a new timer.
41
- * @param length
42
- * @returns Promise that resolves to the timer ID (UUID)
43
- * @throws If length is invalid(e.g. length < 0) or file operation fails
44
- * @example
45
- * const manager = new PlainTextTimersManager();
46
- * const newTimer = await manager.createTimer(5000);
47
- * // newTimer will be id of the timer
48
- */
49
- async createTimer(options) {
50
- try {
51
- if (options < 0) {
52
- throw new Error(`Invailed length: ${options}`);
53
- }
54
- const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
55
- await this.checkTimerfileSyntax(timersRaw);
56
- const length = Math.trunc(options);
57
- // uuid, start, end
58
- const id = uuidv4();
59
- const now = Date.now();
60
- const newTimerData = `${id} ${now.toString()} ${(now + length).toString()}`;
61
- await fs.promises.appendFile(this.timerfiledir, newTimerData + "\n");
62
- return id;
63
- }
64
- catch (e) {
65
- throw new Error(`Error when creating timer: ${e}`);
66
- }
67
- }
68
- /**
69
- * removeTimer
70
- * @description Removes a timer by ID.
71
- * @param id ID of the timer to remove
72
- * @returns void
73
- * @throws If file operation fails
74
- * @example
75
- * await manager.removeTimer(id);
76
- */
77
- async removeTimer(id) {
78
- try {
79
- const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
80
- await this.checkTimerfileSyntax(timersRaw);
81
- const rl = readline.createInterface({
82
- input: fs.createReadStream(this.timerfiledir),
83
- crlfDelay: Infinity,
84
- });
85
- const newTimersDataLines = [];
86
- let found = false;
87
- for await (const line of rl) {
88
- if (!line.trim())
89
- continue;
90
- const [timerId] = line.split(" ");
91
- if (timerId === id) {
92
- found = true;
93
- continue;
94
- }
95
- newTimersDataLines.push(line);
96
- }
97
- if (!found) {
98
- throw new Error(`Timer with id ${id} not found`);
99
- }
100
- await fs.promises.writeFile(this.timerfiledir, newTimersDataLines.join("\n"), "utf-8");
101
- return;
102
- }
103
- catch (e) {
104
- throw new Error(`Error when removing timer: ${e}`);
105
- }
106
- }
107
- /**
108
- * checkTimers
109
- * @description Starts monitoring expired timers asynchronously and returns immediately. The callback is invoked asynchronously when a timer expires.
110
- * The callback is awaited before continuing.
111
- * @param callback Function invoked when an expired timer is detected (called asynchronously)
112
- * @param interval (number, optional): Check interval in milliseconds (default: 200ms)
113
- * @throws If file operation fails
114
- * @returns (NodeJS.Timeout) intervalId interval id of checkTimers
115
- * @example
116
- * const interval = manager.checkTimers((timer) => {
117
- * console.log(`A timer was stopped: ${timer.id}`);
118
- * });
119
- */
120
- checkTimers(callback, interval = 200) {
121
- return setInterval(async () => {
122
- if (this.checkLock)
123
- return;
124
- this.checkLock = true;
125
- try {
126
- const rl = readline.createInterface({
127
- input: fs.createReadStream(this.timerfiledir),
128
- crlfDelay: Infinity,
129
- });
130
- for await (const line of rl) {
131
- if (!line.trim())
132
- continue;
133
- const [id, startStr, stopStr] = line.split(" ");
134
- const timer = {
135
- id: id,
136
- start: Number(startStr),
137
- stop: Number(stopStr),
138
- };
139
- const now = Date.now();
140
- if (Number(timer.stop) <= now) {
141
- await this.removeTimer(timer.id);
142
- callback(timer).catch(async (e) => {
143
- await Log.ensureLogger();
144
- if (Log.loggerInstance) {
145
- Log.loggerInstance.error(`Error in timer callback: ${e}`);
146
- }
147
- });
148
- }
149
- }
150
- }
151
- catch (e) {
152
- await Log.ensureLogger();
153
- if (Log.loggerInstance) {
154
- Log.loggerInstance.error(`Error when checking alarm: ${e}`);
155
- }
156
- }
157
- finally {
158
- this.checkLock = false;
159
- }
160
- }, interval);
161
- }
162
- /**
163
- * showTimers
164
- * @description Retrieves all active timers.
165
- * @returns Array of `Timer` objects
166
- * @throws If file operation fails
167
- * @example
168
- * const timers = await manager.showTimers();
169
- * console.log(JSON.stringify(timers))
170
- */
171
- async showTimers() {
172
- try {
173
- const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
174
- const timersData = timersRaw.split(/\r?\n/);
175
- const timersJSON = [];
176
- for (const timerData of timersData) {
177
- const splitedTimerData = timerData.split(" ");
178
- if (!timerData.trim())
179
- continue;
180
- timersJSON.push({
181
- id: splitedTimerData[0],
182
- start: Number(splitedTimerData[1]),
183
- stop: Number(splitedTimerData[2]),
184
- });
185
- }
186
- return timersJSON;
187
- }
188
- catch (e) {
189
- throw new Error(`Error when showing timers: ${e}`);
190
- }
191
- }
192
- }
193
- //# sourceMappingURL=PlainTextTimersManager.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PlainTextTimersManager.js","sourceRoot":"","sources":["../../src/PlainTextTimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAGhC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,MAAM,OAAO,sBAAuB,SAAQ,aAA0B;IAC3D,kBAAkB;QAC3B,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACgB,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAC7D,MAAM,QAAQ,GAAG,GAAG,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,QAAQ;aACzB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACxB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACpC,MAAM,UAAU,GAAa,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;gBAAE,QAAQ,EAAE,CAAC;YACxC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,EAAE;gBAAE,QAAQ,EAAE,CAAC;YAC7C,IAAI,UAAU,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,KAAK,EAAE;gBAAE,QAAQ,EAAE,CAAC;YAC7C,IAAI,UAAU,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,KAAK,EAAE;gBAAE,QAAQ,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO;IACR,CAAC;IAED;;;;;;;;;;OAUG;IACa,KAAK,CAAC,WAAW,CAAC,OAAwC;QACzE,IAAI,CAAC;YACJ,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACzE,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAE3C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAEnC,mBAAmB;YACnB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG,GAAG,EAAE,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC5E,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC,CAAC;YACrE,OAAO,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACa,KAAK,CAAC,WAAW,CAAC,EAAU;QAC3C,IAAI,CAAC;YACJ,MAAM,SAAS,GAAW,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACjF,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAE3C,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;gBACnC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,SAAS,EAAE,QAAQ;aACnB,CAAC,CAAC;YACH,MAAM,kBAAkB,GAAa,EAAE,CAAC;YACxC,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC;gBAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;oBACpB,KAAK,GAAG,IAAI,CAAC;oBACb,SAAS;gBACV,CAAC;gBACD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YACvF,OAAO;QACR,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;OAYG;IACa,WAAW,CAAC,QAAsD,EAAE,WAAmB,GAAG;QACzG,OAAO,WAAW,CAAC,KAAK,IAAI,EAAE;YAC7B,IAAI,IAAI,CAAC,SAAS;gBAAE,OAAO;YAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC;gBACJ,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;oBACnC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;oBAC7C,SAAS,EAAE,QAAQ;iBACnB,CAAC,CAAC;gBAEH,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC;oBAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;wBAAE,SAAS;oBAC3B,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAChD,MAAM,KAAK,GAAuB;wBACjC,EAAE,EAAE,EAAG;wBACP,KAAK,EAAE,MAAM,CAAC,QAAS,CAAC;wBACxB,IAAI,EAAE,MAAM,CAAC,OAAQ,CAAC;qBACtB,CAAC;oBACF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBACvB,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;wBAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;wBACjC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;4BACjC,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;4BACzB,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;gCACxB,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE,CAAC,CAAC;4BAC3D,CAAC;wBACF,CAAC,CAAC,CAAC;oBACJ,CAAC;gBACF,CAAC;YACF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;gBACzB,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;oBACxB,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;gBAC7D,CAAC;YACF,CAAC;oBAAS,CAAC;gBACV,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACxB,CAAC;QACF,CAAC,EAAE,QAAQ,CAAC,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACa,KAAK,CAAC,UAAU;QAC/B,IAAI,CAAC;YACJ,MAAM,SAAS,GAAW,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACjF,MAAM,UAAU,GAAa,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAEtD,MAAM,UAAU,GAAyB,EAAE,CAAC;YAC5C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC9C,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAChC,UAAU,CAAC,IAAI,CAAC;oBACf,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAE;oBACxB,KAAK,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAE,CAAC;oBACnC,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAE,CAAC;iBAClC,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC;QACnB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;CACD"}
@@ -1,75 +0,0 @@
1
- import type { CreateTimerOptions, StorageType, Timer } from "./types.js";
2
- /**
3
- * TimersManager
4
- * @description
5
- * Manages timers stored in a file.
6
- * (This is a abstract class)
7
- *
8
- * - Timers are persisted in a file
9
- * - Expired timers are detected by polling
10
- */
11
- export declare abstract class TimersManager<T extends StorageType> {
12
- protected readonly timerfiledir: string;
13
- protected checkLock: boolean;
14
- protected abstract getDefaultFilename(): string;
15
- /**
16
- * constructor
17
- * @param timerfiledir(string, optional)
18
- * If omitted, `.timers.jsonl` under the project root is used.
19
- */
20
- constructor(timerfiledir?: string);
21
- /**
22
- * checkTimerfileSyntax
23
- * @description Checks the syntax of the timer file.
24
- * @param fileData
25
- * @returns void
26
- * @throws If syntax is invalid
27
- */
28
- protected abstract checkTimerfileSyntax(fileData: string): Promise<void>;
29
- /**
30
- * createTimer
31
- * @description Creates a new timer.
32
- * @param length Timer duration in milliseconds
33
- * @returns Promise that resolves to the timer ID (UUID)
34
- * @throws If length is invalid(e.g. length < 0) or file operation fails
35
- * @example
36
- * const manager = new TimersManager();
37
- * const newTimer = await manager.createTimer(5000);
38
- * // newTimer will be id of the timer
39
- */
40
- abstract createTimer(options: CreateTimerOptions<T>): Promise<string>;
41
- /**
42
- * removeTimer
43
- * @description Removes a timer by ID.
44
- * @param id ID of the timer to remove
45
- * @returns void
46
- * @throws If file operation fails
47
- * @example
48
- * await manager.removeTimer(id);
49
- */
50
- abstract removeTimer(id: string): Promise<void>;
51
- /**
52
- * @description Starts monitoring expired timers asynchronously and returns immediately. The callback is invoked asynchronously when a timer expires.
53
- * The callback is awaited before continuing.
54
- * @param callback Function invoked when an expired timer is detected (called asynchronously)
55
- * @param interval (number, optional): Check interval in milliseconds (default: 200ms)
56
- * @throws If file operation fails
57
- * @returns (NodeJS.Timeout) intervalId interval id of checkTimers
58
- * @example
59
- * const interval = manager.checkTimers((timer) => {
60
- * console.log(`A timer was stopped: ${timer.id}`);
61
- * });
62
- */
63
- abstract checkTimers(callback: (timer: Timer<T>) => Promise<void>, interval?: number): NodeJS.Timeout;
64
- /**
65
- * showTimers
66
- * @description Retrieves all active timers.
67
- * @returns Array of `Timer` objects
68
- * @throws If file operation fails
69
- * @example
70
- * const timers = await manager.showTimers();
71
- * console.log(JSON.stringify(timers))
72
- */
73
- abstract showTimers(): Promise<Timer<T>[]>;
74
- }
75
- //# sourceMappingURL=TimersManager.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"TimersManager.d.ts","sourceRoot":"","sources":["../../src/TimersManager.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEzE;;;;;;;;GAQG;AACH,8BAAsB,aAAa,CAAC,CAAC,SAAS,WAAW;IACxD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IACxC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAS;IAErC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,MAAM;IAE/C;;;;OAIM;gBAEL,YAAY,CAAC,EAAE,MAAM;IAYtB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExE;;;;;;;;;;OAUM;aACc,WAAW,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAEhF;;;;;;;;OAQM;aACU,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtD;;;;;;;;;;;OAWM;aACc,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO;IAEhH;;;;;;;;OAQM;aACU,UAAU,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;CACjD"}
@@ -1,32 +0,0 @@
1
- import path from "path";
2
- import fs from "fs";
3
- import searchRoot from "./searchRoot.js";
4
- /**
5
- * TimersManager
6
- * @description
7
- * Manages timers stored in a file.
8
- * (This is a abstract class)
9
- *
10
- * - Timers are persisted in a file
11
- * - Expired timers are detected by polling
12
- */
13
- export class TimersManager {
14
- timerfiledir;
15
- checkLock = false;
16
- /**
17
- * constructor
18
- * @param timerfiledir(string, optional)
19
- * If omitted, `.timers.jsonl` under the project root is used.
20
- */
21
- constructor(timerfiledir) {
22
- this.timerfiledir =
23
- timerfiledir ?? path.join(searchRoot(), this.getDefaultFilename());
24
- try {
25
- fs.accessSync(this.timerfiledir);
26
- }
27
- catch {
28
- fs.writeFileSync(this.timerfiledir, "");
29
- }
30
- }
31
- }
32
- //# sourceMappingURL=TimersManager.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"TimersManager.js","sourceRoot":"","sources":["../../src/TimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAGzC;;;;;;;;GAQG;AACH,MAAM,OAAgB,aAAa;IACf,YAAY,CAAS;IAC9B,SAAS,GAAY,KAAK,CAAC;IAIrC;;;;OAIM;IACN,YACC,YAAqB;QAErB,IAAI,CAAC,YAAY;YACP,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAE7E,IAAI,CAAC;YACJ,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACR,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACzC,CAAC;IACF,CAAC;CA2DD"}