diff options
author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-11 21:07:14 +0300 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-12 03:18:01 +0300 |
commit | df5d41bf93a304af4159398d0d9f44f0cba4ac94 (patch) | |
tree | 83970afaa89bf7328b7491a680a62e2acf988a40 /doc/api/timers.md | |
parent | 068c001dee01e8ac7401e97249c5f61215aed233 (diff) |
doc: add and unify even more return values
PR-URL: https://github.com/nodejs/node/pull/19955
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/timers.md')
-rw-r--r-- | doc/api/timers.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api/timers.md b/doc/api/timers.md index 6a994c9c154..b95c6396032 100644 --- a/doc/api/timers.md +++ b/doc/api/timers.md @@ -28,6 +28,8 @@ functions that can be used to control this default behavior. added: v9.7.0 --> +* Returns: {Immediate} + When called, requests that the Node.js event loop *not* exit so long as the `Immediate` is active. Calling `immediate.ref()` multiple times will have no effect. @@ -42,6 +44,8 @@ Returns a reference to the `Immediate`. added: v9.7.0 --> +* Returns: {Immediate} + When called, the active `Immediate` object will not require the Node.js event loop to remain active. If there is no other activity keeping the event loop running, the process may exit before the `Immediate` object's callback is @@ -66,6 +70,8 @@ control this default behavior. added: v0.9.1 --> +* Returns: {Timeout} + When called, requests that the Node.js event loop *not* exit so long as the `Timeout` is active. Calling `timeout.ref()` multiple times will have no effect. @@ -79,6 +85,8 @@ Returns a reference to the `Timeout`. added: v0.9.1 --> +* Returns: {Timeout} + When called, the active `Timeout` object will not require the Node.js event loop to remain active. If there is no other activity keeping the event loop running, the process may exit before the `Timeout` object's callback is invoked. Calling @@ -147,6 +155,7 @@ added: v0.0.1 * `delay` {number} The number of milliseconds to wait before calling the `callback`. * `...args` {any} Optional arguments to pass when the `callback` is called. +* Returns: {Timeout} Schedules repeated execution of `callback` every `delay` milliseconds. Returns a `Timeout` for use with [`clearInterval()`][]. @@ -165,6 +174,7 @@ added: v0.0.1 * `delay` {number} The number of milliseconds to wait before calling the `callback`. * `...args` {any} Optional arguments to pass when the `callback` is called. +* Returns: {Timeout} Schedules execution of a one-time `callback` after `delay` milliseconds. Returns a `Timeout` for use with [`clearTimeout()`][]. |