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

renameメソッドは、特定の対象の名前を変更する機能を提供するメソッドです。Node.jsの標準Objectクラスには、この名前の直接的なメソッドは含まれていません。しかし、もしこのrenameメソッドがObjectクラスに存在すると仮定した場合、それは通常、オブジェクト自身の識別子、またはオブジェクトが管理する内部的なプロパティ名や、外部リソースへの参照名などを、既存の値から新しい値へと更新するために利用されるでしょう。

例えば、{ oldKey: 'value' }という形式でデータを保持するオブジェクトのプロパティ名を{ newKey: 'value' }のように変更したり、あるいはオブジェクトが表現するエンティティの識別子（ID）を更新したりする用途が考えられます。このメソッドは、一般的に変更前の名前（旧名）と変更後の名前（新名）を引数として受け取り、対象の名称を適切に更新します。操作の成功/失敗を示すブール値や、更新されたオブジェクト自身を返却することがあります。また、名前変更の操作が非同期的な処理を伴う場合は、Promiseを返して結果を通知することも一般的です。この機能は、データ管理やリファクタリングのシナリオにおいて、一貫性を保ちながら識別子を更新する際に有用です。

Copy
1import { rename } from 'node:fs/promises';
2
3async function performRename() {
4  const oldPath = 'oldfile.txt';
5  const newPath = 'newfile.txt';
6  try {
7    await rename(oldPath, newPath);
8    console.log(`Successfully renamed "${oldPath}" to "${newPath}".`);
9  } catch (error) {
10    console.error(`Error renaming "${oldPath}" to "${newPath}":`, error);
11  }
12}
13
14performRename();

oldPath, newPath, callback

• oldPath: string: 変更前のファイルまたはディレクトリのパス
• newPath: string: 変更後のファイルまたはディレクトリのパス
• callback: function: 処理完了時に呼び出されるコールバック関数。エラーが発生した場合は err 引数にエラーオブジェクトが渡されます。

戻り値なし

戻り値はありません