@xylabs/timer 5.0.84 → 5.0.86
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/README.md +15 -20
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
|
|
16
16
|
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
17
17
|
|
|
18
|
+
|
|
19
|
+
|
|
18
20
|
## Reference
|
|
19
21
|
|
|
20
22
|
**@xylabs/timer**
|
|
@@ -23,8 +25,10 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
|
23
25
|
|
|
24
26
|
## Functions
|
|
25
27
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
+
| Function | Description |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| [setTimeoutEx](#functions/setTimeoutEx) | Sets a timeout using an optimized internal timer that coalesces multiple timeouts into a single native timer. |
|
|
31
|
+
| [clearTimeoutEx](#functions/clearTimeoutEx) | Cancels a timeout previously created with setTimeoutEx. |
|
|
28
32
|
|
|
29
33
|
### functions
|
|
30
34
|
|
|
@@ -35,18 +39,16 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
|
35
39
|
***
|
|
36
40
|
|
|
37
41
|
```ts
|
|
38
|
-
function clearTimeoutEx(id): void;
|
|
42
|
+
function clearTimeoutEx(id: string): void;
|
|
39
43
|
```
|
|
40
44
|
|
|
41
45
|
Cancels a timeout previously created with setTimeoutEx.
|
|
42
46
|
|
|
43
47
|
## Parameters
|
|
44
48
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
`string`
|
|
48
|
-
|
|
49
|
-
The timeout ID returned by setTimeoutEx.
|
|
49
|
+
| Parameter | Type | Description |
|
|
50
|
+
| ------ | ------ | ------ |
|
|
51
|
+
| `id` | `string` | The timeout ID returned by setTimeoutEx. |
|
|
50
52
|
|
|
51
53
|
## Returns
|
|
52
54
|
|
|
@@ -59,24 +61,17 @@ The timeout ID returned by setTimeoutEx.
|
|
|
59
61
|
***
|
|
60
62
|
|
|
61
63
|
```ts
|
|
62
|
-
function setTimeoutEx(func, delay): string;
|
|
64
|
+
function setTimeoutEx(func: Function, delay: number): string;
|
|
63
65
|
```
|
|
64
66
|
|
|
65
67
|
Sets a timeout using an optimized internal timer that coalesces multiple timeouts into a single native timer.
|
|
66
68
|
|
|
67
69
|
## Parameters
|
|
68
70
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
`Function`
|
|
72
|
-
|
|
73
|
-
The function to call after the delay.
|
|
74
|
-
|
|
75
|
-
### delay
|
|
76
|
-
|
|
77
|
-
`number`
|
|
78
|
-
|
|
79
|
-
The delay in milliseconds (must be >= 0).
|
|
71
|
+
| Parameter | Type | Description |
|
|
72
|
+
| ------ | ------ | ------ |
|
|
73
|
+
| `func` | `Function` | The function to call after the delay. |
|
|
74
|
+
| `delay` | `number` | The delay in milliseconds (must be >= 0). |
|
|
80
75
|
|
|
81
76
|
## Returns
|
|
82
77
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/timer",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.86",
|
|
4
4
|
"description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"xylabs",
|
|
@@ -43,11 +43,11 @@
|
|
|
43
43
|
"!**/*.test.*"
|
|
44
44
|
],
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@xylabs/assert": "~5.0.
|
|
46
|
+
"@xylabs/assert": "~5.0.86"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@xylabs/ts-scripts-yarn3": "~7.4.
|
|
50
|
-
"@xylabs/tsconfig": "~7.4.
|
|
49
|
+
"@xylabs/ts-scripts-yarn3": "~7.4.16",
|
|
50
|
+
"@xylabs/tsconfig": "~7.4.16",
|
|
51
51
|
"typescript": "~5.9.3",
|
|
52
52
|
"vitest": "^4.0.18"
|
|
53
53
|
},
|