Skip to content

Commit cd4dbf3

Browse files
committed
doc: add added: information for timers
Ref: #6578 PR-URL: #7493 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent a2ee21d commit cd4dbf3

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/api/timers.md

+24
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ export both `timeout.ref()` and `timeout.unref()` functions that can be used to
2929
control this default behavior.
3030

3131
### timeout.ref()
32+
<!-- YAML
33+
added: v0.9.1
34+
-->
3235

3336
When called, requests that the Node.js event loop *not* exit so long as the
3437
`Timeout` is active. Calling `timeout.ref()` multiple times will have no effect.
@@ -40,6 +43,9 @@ previously.
4043
Returns a reference to the `Timeout`.
4144

4245
### timeout.unref()
46+
<!-- YAML
47+
added: v0.9.1
48+
-->
4349

4450
When called, the active `Timeout` object will not require the Node.js event loop
4551
to remain active. If there is no other activity keeping the event loop running,
@@ -60,6 +66,9 @@ which method was used to create the timer and what other work the Node.js
6066
event loop is doing.
6167

6268
### setImmediate(callback[, ...arg])
69+
<!-- YAML
70+
added: v0.9.1
71+
-->
6372

6473
* `callback` {Function} The function to call at the end of this turn of
6574
[the Node.js Event Loop]
@@ -79,6 +88,9 @@ next event loop iteration.
7988
If `callback` is not a function, a [`TypeError`][] will be thrown.
8089

8190
### setInterval(callback, delay[, ...arg])
91+
<!-- YAML
92+
added: v0.0.1
93+
-->
8294

8395
* `callback` {Function} The function to call when the timer elapses.
8496
* `delay` {number} The number of milliseconds to wait before calling the
@@ -94,6 +106,9 @@ set to `1`.
94106
If `callback` is not a function, a [`TypeError`][] will be thrown.
95107

96108
### setTimeout(callback, delay[, ...arg])
109+
<!-- YAML
110+
added: v0.0.1
111+
-->
97112

98113
* `callback` {Function} The function to call when the timer elapses.
99114
* `delay` {number} The number of milliseconds to wait before calling the
@@ -120,19 +135,28 @@ each return objects that represent the scheduled timers. These can be used to
120135
cancel the timer and prevent it from triggering.
121136

122137
### clearImmediate(immediate)
138+
<!-- YAML
139+
added: v0.9.1
140+
-->
123141

124142
* `immediate` {Immediate} An `Immediate` object as returned by
125143
[`setImmediate()`][].
126144

127145
Cancels an `Immediate` object created by [`setImmediate()`][].
128146

129147
### clearInterval(timeout)
148+
<!-- YAML
149+
added: v0.0.1
150+
-->
130151

131152
* `timeout` {Timeout} A `Timeout` object as returned by [`setInterval()`][].
132153

133154
Cancels a `Timeout` object created by [`setInterval()`][].
134155

135156
### clearTimeout(timeout)
157+
<!-- YAML
158+
added: v0.0.1
159+
-->
136160

137161
* `timeout` {Timeout} A `Timeout` object as returned by [`setTimeout()`][].
138162

0 commit comments

Comments
 (0)