GeezerVison is showing github.com — timers: document ref option for scheduler.wait · nodejs/node@b6ed97c
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/timers.md +3Lines changed: 3 additions & 0 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -521,6 +521,9 @@ added: |
521 | 521 | * `delay` {number} The number of milliseconds to wait before resolving the |
522 | 522 | promise. |
523 | 523 | * `options` {Object} |
| 524 | + * `ref` {boolean} Set to `false` to indicate that the scheduled `Timeout` |
| 525 | + should not require the Node.js event loop to remain active. |
| 526 | + **Default:** `true`. |
524 | 527 | * `signal` {AbortSignal} An optional `AbortSignal` that can be used to |
525 | 528 | cancel waiting. |
526 | 529 | * Returns: {Promise} |
|
Collapse file
Copy file name to clipboardExpand all lines: lib/timers/promises.js +9-13Lines changed: 9 additions & 13 deletions | Original file line number | Diff line number | Diff line change |
|---|
@@ -131,22 +131,18 @@ function setImmediate(value, options = kEmptyObject) { |
131 | 131 | } |
132 | 132 |
|
133 | 133 | async function* setInterval(after, value, options = kEmptyObject) { |
134 | | - try { |
135 | | - if (typeof after !== 'undefined') { |
136 | | - validateNumber(after, 'delay'); |
137 | | - } |
| 134 | + if (typeof after !== 'undefined') { |
| 135 | + validateNumber(after, 'delay'); |
| 136 | + } |
138 | 137 |
|
139 | | - validateObject(options, 'options'); |
| 138 | + validateObject(options, 'options'); |
140 | 139 |
|
141 | | - if (typeof options?.signal !== 'undefined') { |
142 | | - validateAbortSignal(options.signal, 'options.signal'); |
143 | | - } |
| 140 | + if (typeof options?.signal !== 'undefined') { |
| 141 | + validateAbortSignal(options.signal, 'options.signal'); |
| 142 | + } |
144 | 143 |
|
145 | | - if (typeof options?.ref !== 'undefined') { |
146 | | - validateBoolean(options.ref, 'options.ref'); |
147 | | - } |
148 | | - } catch (err) { |
149 | | - return PromiseReject(err); |
| 144 | + if (typeof options?.ref !== 'undefined') { |
| 145 | + validateBoolean(options.ref, 'options.ref'); |
150 | 146 | } |
151 | 147 |
|
152 | 148 | const { signal, ref = true } = options; |
|