path.relative

関数の概要

path.relativeは、2つのパスを比較して、1つのパスからもう1つのパスへの相対パスを返すNode.jsの関数です。主に、あるパスから別のパスへの相対的な位置関係を求める際に使用されます。

パラメータの説明

戻り値

返り値は文字列型で、fromからtoへの相対パスを示します。同期的な関数です。

使用例

例1：fromからtoへの相対パスを求める

const path = require('path');
const from = '/Users/user/documents';
const to = '/Users/user/projects';
const relativePath = path.relative(from, to);
console.log(relativePath);

例2：別の例

const path = require('path');
const from = '/folder1';
const to = '/folder1/subfolder/file.txt';
const relativePath = path.relative(from, to);
console.log(relativePath);

関連する関数

• path.resolve: パスを解決して絶対パスを返す
• path.join: 複数のパスを連結して1つのパスに結合する

まとめ

path.relativeは、2つのパス間の相対パスを求める際に便利な関数です。基準となるパスと対象のパスを指定することで、相対パスを簡単に取得できます。注意点として、パスの書式や区切り文字に注意する必要があります。