Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit ea8fe04

Browse filesBrowse files
seishunMylesBorins
authored andcommitted
doc: document intention and dangers of fs module Buffer API
PR-URL: #6020 Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent fb64630 commit ea8fe04
Copy full SHA for ea8fe04

File tree

Expand file treeCollapse file tree

1 file changed

+12
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+12
-0
lines changed
Open diff view settings
Collapse file

‎doc/api/fs.markdown‎

Copy file name to clipboardExpand all lines: doc/api/fs.markdown
+12Lines changed: 12 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,18 @@ Error: EISDIR, read
9494
<etc.>
9595
```
9696

97+
## Buffer API
98+
99+
`fs` functions support passing and receiving paths as both strings
100+
and Buffers. The latter is intended to make it possible to work with
101+
filesystems that allow for non-UTF-8 filenames. For most typical
102+
uses, working with paths as Buffers will be unnecessary, as the string
103+
API converts to and from UTF-8 automatically.
104+
105+
*Note* that on certain file systems (such as NTFS and HFS+) filenames
106+
will always be encoded as UTF-8. On such file systems, passing
107+
non-UTF-8 encoded Buffers to `fs` functions will not work as expected.
108+
97109
## Class: fs.FSWatcher
98110

99111
Objects returned from `fs.watch()` are of this type.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.