Skip to content

Commit cfd5773

Browse files
mcollinaBethGriggs
authored andcommitted
doc: document fs.write limitation with TTY
Fixes: #24550 PR-URL: #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]>
1 parent 1d083e2 commit cfd5773

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/api/fs.md

+8
Original file line numberDiff line numberDiff line change
@@ -3501,6 +3501,13 @@ On Linux, positional writes don't work when the file is opened in append mode.
35013501
The kernel ignores the position argument and always appends the data to
35023502
the end of the file.
35033503

3504+
On Windows, if the file descriptor is connected to the console (e.g. `fd == 1`
3505+
or `stdout`) a string containing non-ASCII characters will not be rendered
3506+
properly by default, regardless of the encoding used.
3507+
It is possible to configure the console to render UTF-8 properly by changing the
3508+
active codepage with the `chcp 65001` command. See the [chcp][] docs for more
3509+
details.
3510+
35043511
## fs.writeFile(file, data[, options], callback)
35053512
<!-- YAML
35063513
added: v0.1.29
@@ -4899,3 +4906,4 @@ the file contents.
48994906
[Writable Stream]: stream.html#stream_class_stream_writable
49004907
[inode]: https://en.wikipedia.org/wiki/Inode
49014908
[support of file system `flags`]: #fs_file_system_flags
4909+
[chcp]: https://ss64.com/nt/chcp.html

0 commit comments

Comments
 (0)