【Node.js24.x】Object::readlinkSync()メソッドの使い方
readlinkSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
readlinkSyncメソッドは、ファイルシステム上でシンボリックリンクのターゲットパスを同期的に読み取るメソッドです。シンボリックリンクとは、あるファイルやディレクトリへの「ショートカット」のようなもので、実際のデータは別の場所に存在します。このメソッドは、指定されたパスがシンボリックリンクである場合に、そのリンクが実際にどのファイルやディレクトリを指しているのかを調べ、そのパス文字列を返します。
「同期的に」とは、この処理が完了し、結果が返されるまで、プログラムの実行が一時停止することを意味します。そのため、短時間で終わる処理であれば問題ありませんが、ファイルアクセスに時間がかかる可能性がある場合は、プログラム全体がブロックされる可能性がある点に注意が必要です。
このメソッドは、例えばシステム内で特定のファイルがシンボリックリンクであるかどうかを判断し、それが指す実際のファイルパスを知りたい場合に活用できます。指定されたパスがシンボリックリンクではない場合や、存在しないパスである場合には、エラーが発生します。ファイルシステムの構造を検査し、シンボリックリンクの情報を直接取得する際に非常に役立つ機能を提供します。
構文(syntax)
1const fs = require('node:fs'); 2 3const symlinkPath = '/path/to/symlink'; 4const targetPath = fs.readlinkSync(symlinkPath);
引数(parameters)
path, options
- path: string | URL | Buffer: 読み取るシンボリックリンクのパス
- options: object | undefined: オプションを設定するオブジェクト
戻り値(return)
string | Buffer
readlinkSync メソッドは、シンボリックリンクの実際のパスを返します。返される値は、指定されたエンコーディングによって文字列または Buffer オブジェクトになります。