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

unlinkSyncメソッドは、指定されたファイルパスにあるファイルを同期的に削除するメソッドです。このメソッドはNode.jsのfs（ファイルシステム）モジュールに属しており、ファイルシステムに対する低レベルな操作を提供します。利用する際は、require('fs').unlinkSync()のようにして呼び出します。

引数として、削除したいファイルのパスを文字列で指定します。メソッドが正常に実行されると、指定されたパスのファイルはファイルシステムから完全に削除されます。成功した場合、このメソッドは特別な戻り値としてundefinedを返します。しかし、指定されたファイルが存在しない場合、あるいはファイルへのアクセス権がない場合など、何らかの理由でファイルの削除に失敗した場合は、エラー（例外）をスローします。そのため、予期せぬプログラムの停止を防ぐために、try-catchブロックなどを用いて適切にエラーハンドリングを行うことが重要です。

unlinkSyncの「Sync」は同期処理を意味しており、このメソッドの実行が完了するまで、Node.jsアプリケーションのメインスレッドにおける他の処理は一時的に停止します。この特性から、大量のファイルを削除する場合や、頻繁に呼び出すようなアプリケーションのコア部分では、プログラム全体のパフォーマンスに影響を与え、ユーザーインターフェースが固まるなどの問題を引き起こす可能性があります。一般的には、処理をブロックしない非同期版のfs.unlinkメソッドの利用が推奨されます。しかし、アプリケーションの起動時における一時ファイルのクリーンアップや、シンプルなツール、あるいはブロッキングが許容される特定のスクリプト実行時など、限られたシナリオではその簡潔さからunlinkSyncが便利に活用されます。

Copy
1const fs = require('fs');
2
3fs.unlinkSync('path/to/file.txt');

path

• path: string: 削除するファイルのパスを指定する文字列

戻り値なし

戻り値はありません