@@ -29,6 +29,9 @@ export both `timeout.ref()` and `timeout.unref()` functions that can be used to
29
29
control this default behavior.
30
30
31
31
### timeout.ref()
32
+ <!-- YAML
33
+ added: v0.9.1
34
+ -->
32
35
33
36
When called, requests that the Node.js event loop * not* exit so long as the
34
37
` Timeout ` is active. Calling ` timeout.ref() ` multiple times will have no effect.
@@ -40,6 +43,9 @@ previously.
40
43
Returns a reference to the ` Timeout ` .
41
44
42
45
### timeout.unref()
46
+ <!-- YAML
47
+ added: v0.9.1
48
+ -->
43
49
44
50
When called, the active ` Timeout ` object will not require the Node.js event loop
45
51
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
60
66
event loop is doing.
61
67
62
68
### setImmediate(callback[ , ...arg] )
69
+ <!-- YAML
70
+ added: v0.9.1
71
+ -->
63
72
64
73
* ` callback ` {Function} The function to call at the end of this turn of
65
74
[ the Node.js Event Loop]
@@ -79,6 +88,9 @@ next event loop iteration.
79
88
If ` callback ` is not a function, a [ ` TypeError ` ] [ ] will be thrown.
80
89
81
90
### setInterval(callback, delay[ , ...arg] )
91
+ <!-- YAML
92
+ added: v0.0.1
93
+ -->
82
94
83
95
* ` callback ` {Function} The function to call when the timer elapses.
84
96
* ` delay ` {number} The number of milliseconds to wait before calling the
@@ -94,6 +106,9 @@ set to `1`.
94
106
If ` callback ` is not a function, a [ ` TypeError ` ] [ ] will be thrown.
95
107
96
108
### setTimeout(callback, delay[ , ...arg] )
109
+ <!-- YAML
110
+ added: v0.0.1
111
+ -->
97
112
98
113
* ` callback ` {Function} The function to call when the timer elapses.
99
114
* ` 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
120
135
cancel the timer and prevent it from triggering.
121
136
122
137
### clearImmediate(immediate)
138
+ <!-- YAML
139
+ added: v0.9.1
140
+ -->
123
141
124
142
* ` immediate ` {Immediate} An ` Immediate ` object as returned by
125
143
[ ` setImmediate() ` ] [ ] .
126
144
127
145
Cancels an ` Immediate ` object created by [ ` setImmediate() ` ] [ ] .
128
146
129
147
### clearInterval(timeout)
148
+ <!-- YAML
149
+ added: v0.0.1
150
+ -->
130
151
131
152
* ` timeout ` {Timeout} A ` Timeout ` object as returned by [ ` setInterval() ` ] [ ] .
132
153
133
154
Cancels a ` Timeout ` object created by [ ` setInterval() ` ] [ ] .
134
155
135
156
### clearTimeout(timeout)
157
+ <!-- YAML
158
+ added: v0.0.1
159
+ -->
136
160
137
161
* ` timeout ` {Timeout} A ` Timeout ` object as returned by [ ` setTimeout() ` ] [ ] .
138
162
0 commit comments