diff --git a/doc/api/fs.md b/doc/api/fs.md index 913a34603c9153..52c36616cc7999 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3384,6 +3384,34 @@ The following constants are meant for use with [`fs.copyFile()`][]. +### File Copy Constants + +The following constants are meant for use with [`fs.copyFile()`][]. + + + + + + + + + + + + + + + + + + +
ConstantDescription
COPYFILE_EXCLIf present, the copy operation will fail with an error if the + destination path already exists.
COPYFILE_FICLONEIf present, the copy operation will attempt to create a + copy-on-write reflink. If the underlying platform does not support + copy-on-write, then a fallback copy mechanism is used.
COPYFILE_FICLONE_FORCEIf present, the copy operation will attempt to create a + copy-on-write reflink. If the underlying platform does not support + copy-on-write, then the operation will fail with an error.
+ ### File Open Constants The following constants are meant for use with `fs.open()`.