Skip to content

doc: improve fsPromises.copyFile() documentation and code example #46917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
recrack wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: improve fsPromises.copyFile() documentation and code example #46917

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,19 +937,20 @@ will be made to remove the destination.
```mjs
import { copyFile, constants } from 'node:fs/promises';

// Example 1: Copy the file, overwriting the destination file if it exists
try {
await copyFile('source.txt', 'destination.txt');
console.log('source.txt was copied to destination.txt');
} catch {
console.error('The file could not be copied');
console.log('File copied successfully: source.txt -> destination.txt');
} catch (err) {
console.error(`Error copying file: ${err.message}`);
}

// By using COPYFILE_EXCL, the operation will fail if destination.txt exists.
// Example 2: By using COPYFILE_EXCL, the operation will fail if destination.txt exists.
try {
await copyFile('source.txt', 'destination.txt', constants.COPYFILE_EXCL);
console.log('source.txt was copied to destination.txt');
} catch {
console.error('The file could not be copied');
console.log('File copied successfully: source.txt -> destination.txt');
} catch (err) {
console.error(`Error copying file: ${err.message}`);
}
```

Expand Down