Commit a2efe4c
doc: add note about timeout delay > TIMEOUT_MAX
When setTimeout() and setInterval() are called with `delay` greater than
TIMEOUT_MAX (2147483647), the supplied value is ignored and 1 is used
instead. Add a note about this in the timers docs.
PR-URL: #3512
Reviewed-By: Trevor Norris <trev.norris@gmai.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>1 parent 9b05905 commit a2efe4c
1 file changed
Lines changed: 8 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -16,6 +16,10 @@ It is important to note that your callback will probably not be called in exactl | |||
| 16 | 16 | the callback will fire, nor of the ordering things will fire in. The callback will | |
| 17 | 17 | be called as close as possible to the time specified. | |
| 18 | 18 | ||
| 19 | + To follow browser behavior, when using delays larger than 2147483647 | ||
| 20 | + milliseconds (approximately 25 days) or less than 1, the timeout is executed | ||
| 21 | + immediately, as if the `delay` was set to 1. | ||
| 22 | + | ||
| 19 | 23 | ## clearTimeout(timeoutObject) | |
| 20 | 24 | ||
| 21 | 25 | Prevents a timeout from triggering. | |
@@ -26,6 +30,10 @@ To schedule the repeated execution of `callback` every `delay` milliseconds. | |||
| 26 | 30 | Returns a `intervalObject` for possible use with `clearInterval()`. Optionally | |
| 27 | 31 | you can also pass arguments to the callback. | |
| 28 | 32 | ||
| 33 | + To follow browser behavior, when using delays larger than 2147483647 | ||
| 34 | + milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the | ||
| 35 | + `delay`. | ||
| 36 | + | ||
| 29 | 37 | ## clearInterval(intervalObject) | |
| 30 | 38 | ||
| 31 | 39 | Stops an interval from triggering. | |
0 commit comments