【Node.js24.x】Object::copyFile()メソッドの使い方

copyFileメソッドは、Node.js環境において、指定したファイルを別の場所へ非同期にコピーする機能を実行するメソッドです。このメソッドは、Node.jsのファイルシステム操作を提供するfsモジュールの一部として提供されています。

具体的には、コピー元のファイルのパスと、コピー先のファイルのパスを指定することで、元のファイルを変更せずにその内容を新しいファイルとして生成します。この処理は非同期で行われるため、ファイルのコピー中にアプリケーションの他の処理をブロックすることなく、システムの応答性を維持できる点が特徴です。

ファイルのコピー操作においては、オプションを指定することも可能です。例えば、コピー先に同名のファイルが既に存在する場合に、上書きを許可するかどうかといった挙動を制御できます。これにより、意図しないデータの上書きを防ぎ、より安全なファイル操作を実現することが可能です。

ファイルのコピーが成功したか、またはエラーが発生したかを検知するためには、コールバック関数またはPromiseを使用した非同期処理の完了通知メカニズムを利用します。これにより、コピー後の処理を適切に継続したり、エラーが発生した場合に適切な対応をとったりすることができます。

本メソッドは、ファイルのバックアップ、既存ファイルの複製、別のディレクトリへのファイルの移動など、様々なシナリオで活用されます。システムエンジニアを目指す方にとって、ファイル管理やデータ処理の基本的な操作として非常に重要なメソッドの一つです。

Copy
1import { promises as fs } from 'node:fs';
2
3async function copyFileExample() {
4  try {
5    await fs.copyFile('source.txt', 'destination.txt');
6  } catch (error) {
7    // エラー処理はここに記述します
8  }
9}
10
11copyFileExample();

src, dest, mode, callback

• src: string: コピー元のファイルパス
• dest: string: コピー先のファイルパス
• mode: number: (オプション) コピー先のファイルのパーミッション (例: 0o666)
• callback: function: ファイルコピー完了後に実行されるコールバック関数 (err?: Error)

戻り値なし

戻り値はありません