doc: document fs.write limitation with TTY

Fixes: nodejs#24550 PR-URL: nodejs#24571 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Bartosz Sosnowski <[email protected]>
Trott · Nov 28, 2018 · 086482d · 086482d
1 parent 6f64cda
commit 086482d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -3528,6 +3528,13 @@ On Linux, positional writes don't work when the file is opened in append mode.
 The kernel ignores the position argument and always appends the data to
 the end of the file.
 
+On Windows, if the file descriptor is connected to the console (e.g. `fd == 1`
+or `stdout`) a string containing non-ASCII characters will not be rendered
+properly by default, regardless of the encoding used.
+It is possible to configure the console to render UTF-8 properly by changing the
+active codepage with the `chcp 65001` command. See the [chcp][] docs for more
+details.
+
 ## fs.writeFile(file, data[, options], callback)
 <!-- YAML
 added: v0.1.29
@@ -4926,3 +4933,4 @@ the file contents.
 [MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams
 [support of file system `flags`]: #fs_file_system_flags
 [File Access Constants]: #fs_file_access_constants
+[chcp]: https://ss64.com/nt/chcp.html