$fn.copyFile(src, dest)

This function was added in v3.4.0.

Copies a file registered in the file manager to the specified path on the file manager. [Asynchronous]

Note

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Required	Description
src	string	Yes	Source file path
dest	string	Yes	Destination file path
options	object	No	Options

Options Details

Property Name	Type	Required	Default Value	Description
overwrite	boolean	No	true	Whether to overwrite existing files

Note

• Paths must start with / and must end with a file name.
• The destination file name may differ from the source; the file is saved with the destination name.
• If the destination file already exists, it is overwritten.
• Wildcards (*) are not supported.
• If a path includes a nonexistent folder, it is automatically created.
• Throws an exception if an error occurs.
• Maximum size per operation is 5GB.
• The maximum length of file/folder paths is 987 bytes.
• The folder path separator / (slash) is also included in the path length.

Return value

None

Sample

try {
  await $fn.copyFile("/xxxx/yyyy/sss.dat", "/xxxx/zzzz/sss.dat");
} catch (err) {
  console.log("Error", err);
}