関数の概要
fs.realpathは、Node.jsで提供されている関数の一つです。この関数は、指定されたファイルやディレクトリの実際のパス（絶対パス）を取得するために使用されます。ファイルやディレクトリのシンボリックリンクなどを辿って最終的な実体のパスを返すことができます。
パラメータの説明
| 引数 | 型 | 用途 |
|---|---|---|
| path | string | 実体のパスを取得したいファイルやディレクトリのパス |
| options | Object | オプションパラメータを指定できるオブジェクト |
| callback | function | 実行結果を受け取るコールバック関数 |
戻り値
fs.realpathは非同期関数であり、コールバック関数を通じて実行結果を取得します。戻り値はなく、コールバック関数の第二引数に実体のパスが渡されます。
使用例
以下にfs.realpathの使用例を示します。
const fs = require('fs');
fs.realpath('./sample.txt', (err, resolvedPath) => {
if (err) throw err;
console.log('Resolved Path:', resolvedPath);
});
関連する関数
fs.realpathと同様にファイルパスを扱う関数として、fs.realpathSync、fs.realpath.nativeがあります。また、fs.statやfs.readdirなどもファイルシステムを扱う関数として関連しています。
まとめ
fs.realpathは、指定されたファイルやディレクトリの実体のパスを取得するために利用される非同期関数です。シンボリックリンクを辿って最終的なパスを返すため、実際のパスを取得する際に便利です。
