【Node.js24.x】Object::rmdirSync()メソッドの使い方
rmdirSyncメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
rmdirSyncメソッドは、指定されたパスにあるディレクトリを同期的に削除するメソッドです。このメソッドは、ディレクトリの削除処理が完了するまで、プログラムの実行を一時停止します。そのため、削除が完了するまで次の処理には進まず、処理の完了を待ってから次のコードが実行されるという特性があります。
主に、アプリケーションが作成した一時ディレクトリや、不要になった空のディレクトリをクリーンアップする際などに利用されます。削除対象のディレクトリが空でない場合、つまりファイルやサブディレクトリが含まれている場合は、通常は削除に失敗しエラーを発生させます。
Node.js v24の環境では、ディレクトリ内のコンテンツ（ファイルやサブディレクトリ）もすべて含めて再帰的に削除したい場合、fs.rmSyncメソッドの使用が推奨されています。これはrmdirSyncのrecursiveオプションが非推奨となったためですが、rmdirSync自体は引き続き利用可能です。
このメソッドを使用する際は、削除対象のディレクトリが存在しない場合や、プログラムに削除の権限がない場合などにはエラーが発生する可能性があります。そのため、try-catch文などを用いて適切にエラーをハンドリングすることが重要です。また、長時間かかる可能性のある削除処理において、プログラムの応答性を保ちたい場合は、非同期版のfs.rmやfs.promises.rmメソッドの利用を検討してください。
構文(syntax)
1import * as fs from 'node:fs'; 2 3fs.rmdirSync('path/to/directory');
引数(parameters)
path, options = {}
- path: string: 削除するディレクトリのパス
- options: object = {}: 削除操作のオプションを指定するオブジェクト
戻り値(return)
undefined
rmdirSyncメソッドは、指定されたディレクトリを同期的に削除します。このメソッドは、操作が正常に完了した場合、戻り値はありません。