1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: copyedit setTimeout() documentation

Browse Source 
Copyedit the documentation for setTimeout() and enforce wrapping at 80
characters in the markdown file for nearby text.

PR-URL: https://github.com/nodejs/node/pull/4434
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Reviewed-By: jasnell - James M Snell <jasnell@gmail.com>
Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
This commit is contained in:
Rich Trott 2015-12-26 18:39:16 -08:00
parent 11136bf334
commit f241d6685b
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/api/timers.markdown
View File

@ -49,14 +49,14 @@ milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the
## setTimeout(callback, delay[, arg][, ...]) ## setTimeout(callback, delay[, arg][, ...])
To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a To schedule execution of a one-time `callback` after `delay` milliseconds.
`timeoutObject` for possible use with `clearTimeout()`. Optionally you can Returns a `timeoutObject` for possible use with `clearTimeout()`. Optionally you
also pass arguments to the callback. can also pass arguments to the callback.
It is important to note that your callback will probably not be called in exactly The callback will likely not be invoked in precisely `delay` milliseconds.
`delay` milliseconds - Node.js makes no guarantees about the exact timing of when Node.js makes no guarantees about the exact timing of when callbacks will fire,
the callback will fire, nor of the ordering things will fire in. The callback will nor of their ordering. The callback will be called as close as possible to the
be called as close as possible to the time specified. time specified.
To follow browser behavior, when using delays larger than 2147483647 To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, the timeout is executed milliseconds (approximately 25 days) or less than 1, the timeout is executed
@ -64,10 +64,11 @@ immediately, as if the `delay` was set to 1.
## unref() ## unref()
The opaque value returned by [`setTimeout`][] and [`setInterval`][] also has the method The opaque value returned by [`setTimeout`][] and [`setInterval`][] also has the
`timer.unref()` which will allow you to create a timer that is active but if method `timer.unref()` which will allow you to create a timer that is active but
it is the only item left in the event loop, it won't keep the program running. if it is the only item left in the event loop, it won't keep the program
If the timer is already `unref`d calling `unref` again will have no effect. running. If the timer is already `unref`d calling `unref` again will have no
effect.
In the case of `setTimeout` when you `unref` you create a separate timer that In the case of `setTimeout` when you `unref` you create a separate timer that
will wakeup the event loop, creating too many of these may adversely effect will wakeup the event loop, creating too many of these may adversely effect