$fn.copyFile(src, dest, options)

v3.4.0で追加された関数になります。

ファイルマネージャに登録されているファイルを、指定したファイルマネージャ上のパスへコピーします。[非同期]

ノート

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	必須	説明
src	string	はい	コピー元ファイルパス
dest	string	はい	コピー先ファイルパス
options	object	いいえ	オプション

options詳細

プロパティ名	型	必須	デフォルト値	説明
overwrite	boolean	いいえ	true	既存ファイルの上書き可否

ノート

• パスは/（スラッシュ）から始まり、必ずファイル名で終わっている必要があります。
• コピー先のファイル名はコピー元と異なっていても構いません。その場合、コピー先のファイル名で保存されます。
• コピー先に既存ファイルがある場合は、上書きされます。
• ワイルドカード（*）には対応していません。
• パス内に存在しないフォルダが含まれている場合は自動的に作成されます。
• エラーが発生した場合は例外がスローされます。
• 一度に処理可能な最大サイズは 5GB です。
• ファイル・フォルダパスの最大長は987バイトとなります。
• フォルダパスの区切り文字である/（スラッシュ）もパスの長さに含まれます。

戻り値

なし

サンプル

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