Skip to content

doc: add version metadata to timers/promises #36378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cjihrig wants to merge 1 commit into from
Closed

doc: add version metadata to timers/promises #36378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: add version metadata to timers/promises 
Refs: #33950
  • Loading branch information
@cjihrig
cjihrig committed Dec 4, 2020
commit 1b7f1d4df8386f0b56fe0a1ef3cebc12d3e2aa23
9 changes: 9 additions & 0 deletions doc/api/timers.md
View file
Open in desktop
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