diff options
Diffstat (limited to 'doc/api/fs.md')
-rw-r--r-- | doc/api/fs.md | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 246b369f318..46a15ba5473 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -6771,7 +6771,11 @@ operations. The following constants are exported by `fs.constants`. -Not every constant will be available on every operating system. +Not every constant will be available on every operating system; +this is especially important for Windows, where many of the POSIX specific +definitions are not available. +For portable applications it is recommended to check for their presence +before use. To use more than one constant, use the bitwise OR `|` operator. @@ -6824,6 +6828,8 @@ The following constants are meant for use as the `mode` parameter passed to </tr> </table> +The definitions are also available on Windows. + ##### File copy constants The following constants are meant for use with [`fs.copyFile()`][]. @@ -6852,6 +6858,8 @@ The following constants are meant for use with [`fs.copyFile()`][]. </tr> </table> +The definitions are also available on Windows. + ##### File open constants The following constants are meant for use with `fs.open()`. @@ -6946,6 +6954,9 @@ The following constants are meant for use with `fs.open()`. </tr> </table> +On Windows, only `O_APPEND`, `O_CREAT`, `O_EXCL`, `O_RDONLY`, `O_RDWR`, +`O_TRUNC`, `O_WRONLY` and `UV_FS_O_FILEMAP` are available. + ##### File type constants The following constants are meant for use with the {fs.Stats} object's @@ -6990,6 +7001,9 @@ The following constants are meant for use with the {fs.Stats} object's </tr> </table> +On Windows, only `S_IFCHR`, `S_IFDIR`, `S_IFLNK`, `S_IFMT`, and `S_IFREG`, +are available. + ##### File mode constants The following constants are meant for use with the {fs.Stats} object's @@ -7050,6 +7064,8 @@ The following constants are meant for use with the {fs.Stats} object's </tr> </table> +On Windows, only `S_IRUSR` and `S_IWUSR` are available. + ## Notes ### Ordering of callback and promise-based operations |