Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntoine du Hamel <duhamelantoine1995@gmail.com>2022-04-20 11:23:41 +0300
committerMichaƫl Zasso <targos@protonmail.com>2022-04-28 07:56:14 +0300
commit3d65a3b13e61f136dc09027aa12473c2b3003725 (patch)
tree012259a22a22fec5325afd386bbae62e3293a09f /doc/api/tty.md
parent46c880b99b4a74c3a7c99fdd824bf9ce22333987 (diff)
doc: add `node:` prefix for all core modules
Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: https://github.com/nodejs/node/pull/42752 Fixes: https://github.com/nodejs/node/issues/38343 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Diffstat (limited to 'doc/api/tty.md')
-rw-r--r--doc/api/tty.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md
index ea0640274f7..bd73327aaba 100644
--- a/doc/api/tty.md
+++ b/doc/api/tty.md
@@ -6,12 +6,12 @@
<!-- source_link=lib/tty.js -->
-The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes.
-In most cases, it will not be necessary or possible to use this module directly.
-However, it can be accessed using:
+The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream`
+classes. In most cases, it will not be necessary or possible to use this module
+directly. However, it can be accessed using:
```js
-const tty = require('tty');
+const tty = require('node:tty');
```
When Node.js detects that it is being run with a text terminal ("TTY")