【Node.js24.x】Object::rmSync()メソッドの使い方
rmSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
rmSyncメソッドは、Node.jsのファイルシステム操作において、指定されたパスにあるファイルやディレクトリを同期的に削除するために使用されるメソッドです。このメソッドは、Node.jsのfsモジュールを通じて提供されており、ファイルやディレクトリのパスを引数として受け取ります。必要に応じて、削除に関する詳細な挙動を設定するためのオプションオブジェクトも指定できます。例えば、recursive: trueオプションを使用することで、中身が空でないディレクトリも再帰的に削除することが可能ですし、force: trueオプションを指定すれば、存在しないパスに対するエラーを抑制できます。
rmSyncメソッドの大きな特徴は、その「同期」処理にあります。これは、ファイルやディレクトリの削除処理が完了するまで、Node.jsのプログラムが他の処理を一時停止（ブロック）することを意味します。そのため、大規模なファイル操作を行う場合や、アプリケーションの応答性が求められる場面では、プログラム全体のパフォーマンスに影響を与える可能性があります。通常、ファイルシステム操作では非同期版のfs.rmメソッドが推奨されますが、起動時のクリーンアップ処理や、イベントループのブロックが問題とならないユーティリティスクリプトなど、特定の状況下で同期的に処理を完結させたい場合にrmSyncメソッドは役立ちます。このメソッドを利用することで、ファイルシステムの管理をプログラムから確実に行うことができます。
構文(syntax)
1const fs = require('fs'); 2 3fs.rmSync('path/to/remove', { recursive: true });
引数(parameters)
path, options
- path: string | URL | Buffer | fs.PathLike: 削除するファイルまたはディレクトリのパス
- options?: object: オプション設定オブジェクト。以下のプロパティを指定できます。
- recursive?: boolean: true に設定すると、空でないディレクトリも再帰的に削除します。
- force?: boolean: true に設定すると、シンボリックリンクや、存在しないファイル/ディレクトリを無視して操作を続行します。
- maxRetries?: number: ファイルシステム操作の最大再試行回数。
- retryDelay?: number: ファイルシステム操作の再試行間隔（ミリ秒）。
戻り値(return)
戻り値なし
戻り値はありません