Skip to content

Commit

Permalink
doc: add version metadata to timers/promises
Browse files Browse the repository at this point in the history
Refs: #33950

PR-URL: #36378
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
  • Loading branch information
cjihrig authored and danielleadams committed Dec 7, 2020
1 parent 224a647 commit 2649c38
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/api/timers.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,9 @@ added: v0.0.1
Cancels a `Timeout` object created by [`setTimeout()`][].

## Timers Promises API
<!-- YAML
added: v15.0.0
-->

> Stability: 1 - Experimental
Expand All @@ -333,6 +336,9 @@ const timersPromises = require('timers/promises');
```

### `timersPromises.setTimeout([delay[, value[, options]]])`
<!-- YAML
added: v15.0.0
-->

* `delay` {number} The number of milliseconds to wait before resolving the
`Promise`. **Default**: `1`.
Expand All @@ -345,6 +351,9 @@ const timersPromises = require('timers/promises');
cancel the scheduled `Timeout`.

### `timersPromises.setImmediate([value[, options]])`
<!-- YAML
added: v15.0.0
-->

* `value` {any} A value with which the `Promise` is resolved.
* `options` {Object}
Expand Down

0 comments on commit 2649c38

Please sign in to comment.