Skip to main content
copyFile - fs/promises - Node documentation
function copyFile

Usage in Deno

import { copyFile } from "node:fs/promises";
copyFile(
src: PathLike,
dest: PathLike,
mode?: number,
): Promise<void>

Asynchronously copies src to dest. By default, dest is overwritten if it already exists.

No guarantees are made about the atomicity of the copy operation. If an error occurs after the destination file has been opened for writing, an attempt will be made to remove the destination.

import { copyFile, constants } from 'node:fs/promises';

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');
}

// 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');
}

Parameters

src: PathLike

source filename to copy

dest: PathLike

destination filename of the copy operation

optional
mode: number = 0

Optional modifiers that specify the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE)

Return Type

Promise<void>

Fulfills with undefined upon success.