File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -94,6 +94,18 @@ Error: EISDIR, read
94
94
<etc.>
95
95
```
96
96
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
+
97
109
## Class: fs.FSWatcher
98
110
99
111
Objects returned from ` fs.watch() ` are of this type.
You can’t perform that action at this time.
0 commit comments