diff options
Diffstat (limited to 'doc/api/fs.md')
| -rw-r--r-- | doc/api/fs.md | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index beb60973bb..a3edb245ed 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -194,7 +194,7 @@ filesystems that allow for non-UTF-8 filenames. For most typical uses, working with paths as Buffers will be unnecessary, as the string API converts to and from UTF-8 automatically. -*Note* that on certain file systems (such as NTFS and HFS+) filenames +*Note*: On certain file systems (such as NTFS and HFS+) filenames will always be encoded as UTF-8. On such file systems, passing non-UTF-8 encoded Buffers to `fs` functions will not work as expected. @@ -1546,8 +1546,8 @@ 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. -*Note*: The behavior of `fs.open()` is platform-specific for some flags. As such, -opening a directory on macOS and Linux with the `'a+'` flag - see example +*Note*: The behavior of `fs.open()` is platform-specific for some flags. As +such, opening a directory on macOS and Linux with the `'a+'` flag - see example below - will return an error. In contrast, on Windows and FreeBSD, a file descriptor will be returned. @@ -2156,9 +2156,9 @@ effectively stopping watching of `filename`. Calling `fs.unwatchFile()` with a filename that is not being watched is a no-op, not an error. -*Note*: [`fs.watch()`][] is more efficient than `fs.watchFile()` and `fs.unwatchFile()`. -`fs.watch()` should be used instead of `fs.watchFile()` and `fs.unwatchFile()` -when possible. +*Note*: [`fs.watch()`][] is more efficient than `fs.watchFile()` and +`fs.unwatchFile()`. `fs.watch()` should be used instead of `fs.watchFile()` +and `fs.unwatchFile()` when possible. ## fs.utimes(path, atime, mtime, callback) <!-- YAML @@ -2185,7 +2185,7 @@ changes: Change file timestamps of the file referenced by the supplied path. -Note: the arguments `atime` and `mtime` of the following related functions +*Note*: The arguments `atime` and `mtime` of the following related functions follow these rules: - The value should be a Unix timestamp in seconds. For example, `Date.now()` @@ -2366,11 +2366,12 @@ These stat objects are instances of `fs.Stat`. To be notified when the file was modified, not just accessed, it is necessary to compare `curr.mtime` and `prev.mtime`. -*Note*: when an `fs.watchFile` operation results in an `ENOENT` error, it will - invoke the listener once, with all the fields zeroed (or, for dates, the Unix - Epoch). In Windows, `blksize` and `blocks` fields will be `undefined`, instead - of zero. If the file is created later on, the listener will be called again, - with the latest stat objects. This is a change in functionality since v0.10. +*Note*: When an `fs.watchFile` operation results in an `ENOENT` error, it +will invoke the listener once, with all the fields zeroed (or, for dates, the +Unix Epoch). In Windows, `blksize` and `blocks` fields will be `undefined`, +instead of zero. If the file is created later on, the listener will be called +again, with the latest stat objects. This is a change in functionality since +v0.10. *Note*: [`fs.watch()`][] is more efficient than `fs.watchFile` and `fs.unwatchFile`. `fs.watch` should be used instead of `fs.watchFile` and @@ -2577,8 +2578,9 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written. ## FS Constants -The following constants are exported by `fs.constants`. **Note:** Not every -constant will be available on every operating system. +The following constants are exported by `fs.constants`. + +*Note*: Not every constant will be available on every operating system. ### File Access Constants |