Skip to content

Commit ae296f9

Browse files
ExE-Bossaduh95trivikrTrott
committed
doc: document changes for */promises alias modules
Fixes: nodejs#35740 Refs: nodejs#31553 Refs: nodejs#32953 Refs: nodejs#33991 Refs: nodejs#34001 Refs: nodejs#34055 Refs: nodejs#34962 Co-authored-by: Antoine du Hamel <[email protected]> Co-authored-by: Trivikram Kamat <[email protected]> Co-authored-by: Rich Trott <[email protected]>
1 parent 3f4ec9c commit ae296f9

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

doc/api/dns.md

+12
Original file line numberDiff line numberDiff line change
@@ -643,6 +643,18 @@ subsequent servers provided. Fallback DNS servers will only be used if the
643643
earlier ones time out or result in some other error.
644644

645645
## DNS promises API
646+
<!-- YAML
647+
added: v10.6.0
648+
changes:
649+
- version: v15.0.0
650+
pr-url: https://github.com/nodejs/node/pull/32953
651+
description: Exposed as `require('dns/promises')`.
652+
- version:
653+
- v11.14.0
654+
- v10.17.0
655+
pr-url: https://github.com/nodejs/node/pull/26592
656+
description: This API is no longer experimental.
657+
-->
646658

647659
The `dns.promises` API provides an alternative set of asynchronous DNS methods
648660
that return `Promise` objects rather than using callbacks. The API is accessible

doc/api/fs.md

+15
Original file line numberDiff line numberDiff line change
@@ -4594,6 +4594,21 @@ For detailed information, see the documentation of the asynchronous version of
45944594
this API: [`fs.writev()`][].
45954595

45964596
## `fs` Promises API
4597+
<!-- YAML
4598+
added: v10.0.0
4599+
changes:
4600+
- version: v14.0.0
4601+
pr-url: https://github.com/nodejs/node/pull/31553
4602+
description: Exposed as `require('fs/promises')`.
4603+
- version:
4604+
- v11.14.0
4605+
- v10.17.0
4606+
pr-url: https://github.com/nodejs/node/pull/26581
4607+
description: This API is no longer experimental.
4608+
- version: v10.1.0
4609+
pr-url: https://github.com/nodejs/node/pull/20504
4610+
description: The API is accessible via `require('fs').promises` only.
4611+
-->
45974612

45984613
The `fs.promises` API provides an alternative set of asynchronous file system
45994614
methods that return `Promise` objects rather than using callbacks. The

doc/api/stream.md

+3
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ Additionally, this module includes the utility functions
4949
[`stream.Readable.from()`][].
5050

5151
### Streams Promises API
52+
<!-- YAML
53+
added: v15.0.0
54+
-->
5255

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

0 commit comments

Comments
 (0)