関数の概要
fs.copyFileは、Node.jsのファイルシステムモジュールに含まれる関数で、指定されたファイルを別の場所にコピーするために使用されます。主な目的は、ファイルのバックアップや移動などです。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
src | string | コピー元のファイルパス |
dest | string | コピー先のファイルパス |
callback | function | コピー完了後に呼び出されるコールバック関数 |
戻り値
fs.copyFileは非同期関数であり、特に明示的な戻り値を返しません。コピーが成功した場合はコールバック関数が呼び出されます。
使用例
コピー元のファイルをコピー先にコピーする例:
const fs = require('fs');
fs.copyFile('file1.txt', 'file2.txt', (err) => {
if (err) throw err;
console.log('ファイルがコピーされました');
});
別のディレクトリにファイルをコピーする例:
fs.copyFile('dir1/file1.txt', 'dir2/file1.txt', (err) => {
if (err) throw err;
console.log('ファイルが別のディレクトリにコピーされました');
});
関連する関数
- fs.readFile: ファイルを非同期で読み込む
- fs.writeFile: ファイルを非同期で書き込む
まとめ
fs.copyFileはファイルをコピーするための便利な関数です。コピー元とコピー先のパスを指定し、コピーが完了した際にコールバック関数が呼び出されます。非同期処理なので、コピー完了まで待機せずに他の処理を進めることができます。