Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorfoxxyz <foxxyz@gmail.com>2021-06-27 02:03:02 +0300
committerMichaƫl Zasso <targos@protonmail.com>2021-07-11 10:11:34 +0300
commit72f198b0b5b8df478e741ba655401c6ad6c47123 (patch)
tree32d4b1845cacbabb604378f469bbfba7a6d1b977 /doc/api
parent0b27fd0856a0b132c1b1fdc5266ea68cab132747 (diff)
doc: replace outdated `util.promisify` timer examples with references
PR-URL: https://github.com/nodejs/node/pull/39164 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/timers.md45
1 files changed, 10 insertions, 35 deletions
diff --git a/doc/api/timers.md b/doc/api/timers.md
index 89f9ad312e3..cfbc8f1ead4 100644
--- a/doc/api/timers.md
+++ b/doc/api/timers.md
@@ -170,25 +170,7 @@ next event loop iteration.
If `callback` is not a function, a [`TypeError`][] will be thrown.
This method has a custom variant for promises that is available using
-[`util.promisify()`][]:
-
-```js
-const util = require('util');
-const setImmediatePromise = util.promisify(setImmediate);
-
-setImmediatePromise('foobar').then((value) => {
- // value === 'foobar' (passing values is optional)
- // This is executed after all I/O callbacks.
-});
-
-// Or with async function
-async function timerExample() {
- console.log('Before I/O callbacks');
- await setImmediatePromise();
- console.log('After I/O callbacks');
-}
-timerExample();
-```
+[`timersPromises.setImmediate()`][].
### `setInterval(callback[, delay[, ...args]])`
<!-- YAML
@@ -208,6 +190,9 @@ set to `1`. Non-integer delays are truncated to an integer.
If `callback` is not a function, a [`TypeError`][] will be thrown.
+This method has a custom variant for promises that is available using
+[`timersPromises.setInterval()`][].
+
### `setTimeout(callback[, delay[, ...args]])`
<!-- YAML
added: v0.0.1
@@ -232,17 +217,7 @@ will be set to `1`. Non-integer delays are truncated to an integer.
If `callback` is not a function, a [`TypeError`][] will be thrown.
This method has a custom variant for promises that is available using
-[`util.promisify()`][]:
-
-```js
-const util = require('util');
-const setTimeoutPromise = util.promisify(setTimeout);
-
-setTimeoutPromise(40, 'foobar').then((value) => {
- // value === 'foobar' (passing values is optional)
- // This is executed after about 40 milliseconds.
-});
-```
+[`timersPromises.setTimeout()`][].
## Cancelling timers
@@ -257,8 +232,7 @@ returned Promises will be rejected with an `'AbortError'`.
For `setImmediate()`:
```js
-const util = require('util');
-const setImmediatePromise = util.promisify(setImmediate);
+const { setImmediate: setImmediatePromise } = require('timers/promises');
const ac = new AbortController();
const signal = ac.signal;
@@ -276,8 +250,7 @@ ac.abort();
For `setTimeout()`:
```js
-const util = require('util');
-const setTimeoutPromise = util.promisify(setTimeout);
+const { setTimeout: setTimeoutPromise } = require('timers/promises');
const ac = new AbortController();
const signal = ac.signal;
@@ -478,6 +451,8 @@ const interval = 100;
[`setImmediate()`]: #timers_setimmediate_callback_args
[`setInterval()`]: #timers_setinterval_callback_delay_args
[`setTimeout()`]: #timers_settimeout_callback_delay_args
-[`util.promisify()`]: util.md#util_util_promisify_original
+[`timersPromises.setImmediate()`]: #timers_timerspromises_setimmediate_value_options
+[`timersPromises.setInterval()`]: #timers_timerspromises_setinterval_delay_value_options
+[`timersPromises.setTimeout()`]: #timers_timerspromises_settimeout_delay_value_options
[`worker_threads`]: worker_threads.md
[primitive]: #timers_timeout_symbol_toprimitive