diff options
| author | ExE Boss <3889017+ExE-Boss@users.noreply.github.com> | 2020-06-21 16:20:00 +0300 |
|---|---|---|
| committer | Node.js GitHub Bot <github-bot@iojs.org> | 2020-10-25 13:29:21 +0300 |
| commit | 1d5b91d0a792dd903c2ed02e19bd5294ce5a67e3 (patch) | |
| tree | 889566e1e2899ac7846cae526f9fd9856ac57fff | |
| parent | 3e10ce30b471214cc5020a92d628357e9ed4fb91 (diff) | |
doc: document changes for `*/promises` alias modules
Fixes: https://github.com/nodejs/node/issues/35740
Refs: https://github.com/nodejs/node/pull/31553
Refs: https://github.com/nodejs/node/pull/32953
Refs: https://github.com/nodejs/node/pull/33991
Refs: https://github.com/nodejs/node/pull/34001
Refs: https://github.com/nodejs/node/pull/34055
Refs: https://github.com/nodejs/node/pull/34962
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Trivikram Kamat <trivikr.dev@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/34002
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
| -rw-r--r-- | doc/api/dns.md | 12 | ||||
| -rw-r--r-- | doc/api/fs.md | 15 | ||||
| -rw-r--r-- | doc/api/stream.md | 3 |
3 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/dns.md b/doc/api/dns.md index 638321f222a..ac69a3491ae 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -664,6 +664,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 diff --git a/doc/api/fs.md b/doc/api/fs.md index aab3adaaa32..2c2fe3c8626 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -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')`. + - 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. +--> The `fs.promises` API provides an alternative set of asynchronous file system methods that return `Promise` objects rather than using callbacks. The diff --git a/doc/api/stream.md b/doc/api/stream.md index fd70a662ac2..c545b28236d 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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 |