Node.js fs.copyFileSync(src, dest[, mode])用法及代码示例

fs.copyFileSync(src, dest[, mode])

参数

• src <string> | <Buffer> | <URL> 要复制的源文件名
• dest <string> | <Buffer> | <URL> 复制操作的目标文件名
• mode <integer> 用于复制操作的修饰符。 默认： 0 。

将 src 同步复制到 dest 。默认情况下，如果 dest 已经存在，它会被覆盖。返回 undefined 。 Node.js 不保证复制操作的原子性。如果在打开目标文件进行写入后发生错误，Node.js 将尝试删除目标。

mode 是一个可选整数，用于指定复制操作的行为。可以创建由两个或多个值的按位或组成的掩码(例如 fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE )。

• fs.constants.COPYFILE_EXCL ：如果 dest 已存在，则复制操作将失败。
• fs.constants.COPYFILE_FICLONE ：复制操作将尝试创建 copy-on-write reflink。如果平台不支持copy-on-write，则使用回退复制机制。
• fs.constants.COPYFILE_FICLONE_FORCE ：复制操作将尝试创建 copy-on-write reflink。如果平台不支持copy-on-write，则操作将失败。

import { copyFileSync, constants } from 'node:fs';

// destination.txt will be created or overwritten by default.
copyFileSync('source.txt', 'destination.txt');
console.log('source.txt was copied to destination.txt');

// By using COPYFILE_EXCL, the operation will fail if destination.txt exists.
copyFileSync('source.txt', 'destination.txt', constants.COPYFILE_EXCL);