@@ -1991,7 +1991,8 @@ Enables timer mocking for the specified timers.
1991
1991
The currently supported timer values are ` 'setInterval' ` , ` 'setTimeout' ` , ` 'setImmediate' ` ,
1992
1992
and ` 'Date' ` . ** Default:** ` ['setInterval', 'setTimeout', 'setImmediate', 'Date'] ` .
1993
1993
If no array is provided, all time related APIs (` 'setInterval' ` , ` 'clearInterval' ` ,
1994
- ` 'setTimeout' ` , ` 'clearTimeout' ` , and ` 'Date' ` ) will be mocked by default.
1994
+ ` 'setTimeout' ` , ` 'clearTimeout' ` , ` 'setImmediate' ` , ` 'clearImmediate' ` , and
1995
+ ` 'Date' ` ) will be mocked by default.
1995
1996
* ` now ` {number | Date} An optional number or Date object representing the
1996
1997
initial time (in milliseconds) to use as the value
1997
1998
for ` Date.now() ` . ** Default:** ` 0 ` .
@@ -2046,10 +2047,11 @@ mock.timers.enable({ apis: ['Date'], now: new Date() });
2046
2047
2047
2048
Alternatively, if you call ` mock.timers.enable() ` without any parameters:
2048
2049
2049
- All timers (` 'setInterval' ` , ` 'clearInterval' ` , ` 'setTimeout' ` , and ` 'clearTimeout' ` )
2050
- will be mocked. The ` setInterval ` , ` clearInterval ` , ` setTimeout ` , and ` clearTimeout `
2051
- functions from ` node:timers ` , ` node:timers/promises ` ,
2052
- and ` globalThis ` will be mocked. As well as the global ` Date ` object.
2050
+ All timers (` 'setInterval' ` , ` 'clearInterval' ` , ` 'setTimeout' ` , ` 'clearTimeout' ` ,
2051
+ ` 'setImmediate' ` , and ` 'clearImmediate' ` ) will be mocked. The ` setInterval ` ,
2052
+ ` clearInterval ` , ` setTimeout ` , ` clearTimeout ` , ` setImmediate ` , and
2053
+ ` clearImmediate ` functions from ` node:timers ` , ` node:timers/promises ` , and
2054
+ ` globalThis ` will be mocked. As well as the global ` Date ` object.
2053
2055
2054
2056
### ` timers.reset() `
2055
2057
@@ -2080,7 +2082,7 @@ mock.timers.reset();
2080
2082
2081
2083
Calls ` timers.reset() ` .
2082
2084
2083
- ### ` timers.tick(milliseconds) `
2085
+ ### ` timers.tick([ milliseconds] ) `
2084
2086
2085
2087
<!-- YAML
2086
2088
added:
@@ -2091,7 +2093,7 @@ added:
2091
2093
Advances time for all mocked timers.
2092
2094
2093
2095
* ` milliseconds ` {number} The amount of time, in milliseconds,
2094
- to advance the timers.
2096
+ to advance the timers. ** Default: ** ` 1 ` .
2095
2097
2096
2098
** Note:** This diverges from how ` setTimeout ` in Node.js behaves and accepts
2097
2099
only positive numbers. In Node.js, ` setTimeout ` with negative numbers is
0 commit comments