From 0d2262887c0f6aeb19b2e4d73484e6f56807093b Mon Sep 17 00:00:00 2001 From: Tristian Flanagan Date: Wed, 4 Nov 2015 12:35:20 -0500 Subject: [PATCH] doc: sort timers alphabetically Reorders, with no contextual changes, the timers documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas Reviewed-By: James M Snell Reviewed-By: Jeremiah Senkpiel --- doc/api/timers.markdown | 74 ++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/doc/api/timers.markdown b/doc/api/timers.markdown index 1dc456aaad925f..3a087be76a5cf2 100644 --- a/doc/api/timers.markdown +++ b/doc/api/timers.markdown @@ -5,25 +5,38 @@ All of the timer functions are globals. You do not need to `require()` this module in order to use them. -## setTimeout(callback, delay[, arg][, ...]) +## clearImmediate(immediateObject) -To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a -`timeoutObject` for possible use with `clearTimeout()`. Optionally you can -also pass arguments to the callback. +Stops an immediate from triggering. -It is important to note that your callback will probably not be called in exactly -`delay` milliseconds - Node.js makes no guarantees about the exact timing of when -the callback will fire, nor of the ordering things will fire in. The callback will -be called as close as possible to the time specified. +## clearInterval(intervalObject) -To follow browser behavior, when using delays larger than 2147483647 -milliseconds (approximately 25 days) or less than 1, the timeout is executed -immediately, as if the `delay` was set to 1. +Stops an interval from triggering. ## clearTimeout(timeoutObject) Prevents a timeout from triggering. +## ref() + +If you had previously `unref()`d a timer you can call `ref()` to explicitly +request the timer hold the program open. If the timer is already `ref`d calling +`ref` again will have no effect. + +Returns the timer. + +## setImmediate(callback[, arg][, ...]) + +To schedule the "immediate" execution of `callback` after I/O events +callbacks and before `setTimeout` and `setInterval` . Returns an +`immediateObject` for possible use with `clearImmediate()`. Optionally you +can also pass arguments to the callback. + +Callbacks for immediates are queued in the order in which they were created. +The entire callback queue is processed every event loop iteration. If you queue +an immediate from inside an executing callback, that immediate won't fire +until the next event loop iteration. + ## setInterval(callback, delay[, arg][, ...]) To schedule the repeated execution of `callback` every `delay` milliseconds. @@ -34,9 +47,20 @@ To follow browser behavior, when using delays larger than 2147483647 milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the `delay`. -## clearInterval(intervalObject) +## setTimeout(callback, delay[, arg][, ...]) -Stops an interval from triggering. +To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a +`timeoutObject` for possible use with `clearTimeout()`. Optionally you can +also pass arguments to the callback. + +It is important to note that your callback will probably not be called in exactly +`delay` milliseconds - Node.js makes no guarantees about the exact timing of when +the callback will fire, nor of the ordering things will fire in. The callback will +be called as close as possible to the time specified. + +To follow browser behavior, when using delays larger than 2147483647 +milliseconds (approximately 25 days) or less than 1, the timeout is executed +immediately, as if the `delay` was set to 1. ## unref() @@ -50,27 +74,3 @@ will wakeup the event loop, creating too many of these may adversely effect event loop performance -- use wisely. Returns the timer. - -## ref() - -If you had previously `unref()`d a timer you can call `ref()` to explicitly -request the timer hold the program open. If the timer is already `ref`d calling -`ref` again will have no effect. - -Returns the timer. - -## setImmediate(callback[, arg][, ...]) - -To schedule the "immediate" execution of `callback` after I/O events -callbacks and before `setTimeout` and `setInterval` . Returns an -`immediateObject` for possible use with `clearImmediate()`. Optionally you -can also pass arguments to the callback. - -Callbacks for immediates are queued in the order in which they were created. -The entire callback queue is processed every event loop iteration. If you queue -an immediate from inside an executing callback, that immediate won't fire -until the next event loop iteration. - -## clearImmediate(immediateObject) - -Stops an immediate from triggering.