【Node.js24.x】Object::readlink()メソッドの使い方
readlinkメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
readlinkメソッドは、Node.jsのObjectクラスに属し、ファイルシステム上のシンボリックリンクのターゲットパスを読み取るメソッドです。このメソッドは、指定されたパスがシンボリックリンクである場合に、そのリンクが実際に指し示す先のパスを文字列として取得するために使用されます。
このreadlinkメソッドは非同期操作として実行されるため、処理が完了するのを待つことなく、プログラムの他の部分の実行を継続できます。通常、読み取りたいシンボリックリンクのパスを引数として受け取り、その結果を処理するためのコールバック関数を渡して利用します。読み取りが成功した場合、ターゲットパスがコールバック関数に渡されるため、アプリケーションはその情報を利用して、シンボリックリンクの実体であるファイルやディレクトリにアクセスできるようになります。
この機能は、設定ファイルがシンボリックリンクで管理されている場合や、システムがファイルを動的に配置するようなシナリオで特に有用です。シンボリックリンクの利便性を活かしつつ、必要に応じてその実体パスをプログラムで把握できるため、柔軟で堅牢なアプリケーションの開発において重要な役割を果たします。
構文(syntax)
1import { readlink } from 'node:fs/promises'; 2 3async function exampleReadlink() { 4 try { 5 const pathOfSymlink = 'path/to/your/symlink'; // 読み取るシンボリックリンクのパス 6 const options = { encoding: 'utf8' }; // オプション (省略可能): 例 { encoding: 'buffer' } 7 8 const targetPath = await readlink(pathOfSymlink, options); 9 // targetPath にはシンボリックリンクの参照先パスが文字列またはBufferとして格納される 10 } catch (error) { 11 // シンボリックリンクの読み取り失敗時のエラー処理 12 } 13}
引数(parameters)
path, options, callback
- path: string: 読み取りたいシンボリックリンクのパス
- options: object | string: オプションを指定するオブジェクト、またはエンコーディングを指定する文字列
- callback: Function: リンクのターゲットパスが返されたときに呼び出されるコールバック関数。エラーが発生した場合は first argument で、成功した場合は second argument でターゲットパスが渡されます。
戻り値(return)
戻り値なし
戻り値はありません