Skip to content
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

Jump to bottom

doc: document changes for */promises alias modules #34002

Closed
wants to merge 1 commit into from
Closed

doc: document changes for */promises alias modules #34002

Show file tree
Hide file tree
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
12 changes: 12 additions & 0 deletions doc/api/dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,6 +643,18 @@ subsequent servers provided. Fallback DNS servers will only be used if the
earlier ones time out or result in some other error.

## DNS promises API
<!-- YAML
added: v10.6.0
changes:
- version: v15.0.0
pr-url: https://github.com/nodejs/node/pull/32953
description: Exposed as `require('dns/promises')`.
- version:
- v11.14.0
- v10.17.0
pr-url: https://github.com/nodejs/node/pull/26592
description: This API is no longer experimental.
-->

The `dns.promises` API provides an alternative set of asynchronous DNS methods
that return `Promise` objects rather than using callbacks. The API is accessible
Expand Down
15 changes: 15 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4594,6 +4594,21 @@ For detailed information, see the documentation of the asynchronous version of
this API: [`fs.writev()`][].

## `fs` Promises API
<!-- YAML
added: v10.0.0
changes:
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/31553
description: Exposed as `require('fs/promises')`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if we should make it clearer that the API is still accessible via require('fs').promises. Feel free to disregard if you think it's good enough as is.

- version:
- v11.14.0
- v10.17.0
pr-url: https://github.com/nodejs/node/pull/26581
description: This API is no longer experimental.
- version: v10.1.0
pr-url: https://github.com/nodejs/node/pull/20504
description: The API is accessible via `require('fs').promises` only.
-->
ExE-Boss marked this conversation as resolved.
Show resolved Hide resolved

The `fs.promises` API provides an alternative set of asynchronous file system
methods that return `Promise` objects rather than using callbacks. The
Expand Down
3 changes: 3 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ Additionally, this module includes the utility functions
[`stream.Readable.from()`][].

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

The `stream/promises` API provides an alternative set of asynchronous utility
functions for streams that return `Promise` objects rather than using
Expand Down