関数の概要
fs.readlinkは、Node.jsのモジュールであるfsモジュールに含まれる関数の一つです。この関数は、シンボリックリンク（シンボリックリンクとは、ファイルやディレクトリへの参照を示す特殊なファイルのこと）のリンク先を読み取るために使用されます。つまり、シンボリックリンクが指し示すファイルやディレクトリのパスを取得することができます。
パラメータの説明
| パラメータ | 型 | 用途 |
|---|---|---|
| path | string | シンボリックリンクのパス |
| options | Object | オプションパラメータ（省略可能） |
| callback | Function | コールバック関数 |
戻り値
fs.readlinkの戻り値は、シンボリックリンクが指し示すファイルやディレクトリのパスを表す文字列です。非同期処理であり、コールバック関数を使用して取得したパスを扱います。
使用例
以下にfs.readlinkの使用例を示します。
const fs = require('fs');
fs.readlink('/path/to/symlink', (err, target) => {
if (err) throw err;
console.log(target);
});
関連する関数
- fs.realpath: シンボリックリンクの解決に使用される
- fs.symlink: シンボリックリンクを作成するために使用される
まとめ
fs.readlinkは、シンボリックリンクが指し示すファイルやディレクトリのパスを取得するための関数です。非同期処理であるため、コールバック関数を使用して取得したパスを処理することが重要です。
