Skip to content

Commit 3db07ff

Browse files
committed
doc: document fs.write limitation with TTY
Fixes: #24550
1 parent 69cc58d commit 3db07ff

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
@@ -3528,6 +3528,13 @@ On Linux, positional writes don't work when the file is opened in append mode.
35283528
The kernel ignores the position argument and always appends the data to
35293529
the end of the file.
35303530

3531+
On Windows, if the file descriptor is connected to the console (e.g. `fd == 1`
3532+
or `stdout`) a string encoded as UTF-8 or Unicode (`ucs2`) will not be rendered
3533+
properly by default.
3534+
It is possible to configure the console to render UTF-8 properly by changing the
3535+
active codepage with the `chcp 65001` command. See the [chcp][] docs for more
3536+
details.
3537+
35313538
## fs.writeFile(file, data[, options], callback)
35323539
<!-- YAML
35333540
added: v0.1.29
@@ -4926,3 +4933,4 @@ the file contents.
49264933
[MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams
49274934
[support of file system `flags`]: #fs_file_system_flags
49284935
[File Access Constants]: #fs_file_access_constants
4936+
[chcp]: https://ss64.com/nt/chcp.html

0 commit comments

Comments
 (0)