関数の概要
fs.renameは、Node.jsのファイルシステムモジュールで提供される関数の一つです。この関数は、指定されたファイルやディレクトリの名前を変更するために使用されます。ファイルの移動やリネームなど、ファイル操作において名前の変更が必要な場合に利用されます。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
oldPath | string | 変更前のファイルパス |
newPath | string | 変更後のファイルパス |
戻り値
fs.renameは、エラーがない場合には何も返さずに処理が完了します。非同期的な関数であり、コールバック関数を使用して処理の結果を取得します。
使用例
ファイル名を変更する例:
const fs = require('fs');
fs.rename('oldfile.txt', 'newfile.txt', (err) => {
if (err) throw err;
console.log('Rename complete!');
});
ディレクトリ名を変更する例:
const fs = require('fs');
fs.rename('olddir', 'newdir', (err) => {
if (err) throw err;
console.log('Directory renamed!');
});
関連する関数
- fs.unlink: ファイルを削除する際に使用
- fs.mkdir: 新しいディレクトリを作成する際に使用
まとめ
fs.renameはファイルやディレクトリの名前を変更するための関数であり、移動やリネームなどの操作に利用されます。非同期的な関数であるため、コールバック関数を適切に設定することが重要です。