Node.js - path.relative() 方法

---

---

Node.js 的 path 模块提供了各种与操作系统相关的实用程序方法和属性。

path 模块的 Node.js path.relative() 方法根据当前工作目录，返回从一个描述的路径 (from) 到另一个路径 (to) 的相对 path。当 from 和 to 解析到相同的路径（在对每个路径调用 path.resolve() 之后）时，将返回零长度字符串。如果任何 零长度字符串 传递给路径，则此方法将打印 零长度字符串。如果任何描述的 path 不是 字符串，则会抛出 TypeError。

语法

以下是 path 模块的 Node.js path.relative() 方法的语法：

path.relative(from, to)

参数

• from − 此参数包含一个 字符串 文件 路径，表示一个 基路径。

• to − 此参数是一个 字符串 文件 路径，将用于从 基路径 查找 相对路径。

返回值

此方法返回从一个指定的路径 from 到另一个指定的路径 to 的 相对路径。

示例

如果 from 和 to 参数之间存在相对路径，则 path.relative() 方法将返回相对路径。

在下面的示例中，我们向方法的 from 和 to 参数提供 路径。

const path = require('path');

var path1 = path.relative('C:/Users/Lenovo/Desktop/JavaScript/nodefile.js', 'C:/Users/Lenovo/Desktop/JavaScript/file/bose.html')

console.log(path1);

输出

当我们在在线编译器 (POSIX) 中执行上述代码时，输出如下：

../file/bose.html

当我们在 WINDOWS 操作系统上执行上述代码时，输出如下：

..\file\bose.html

示例

如果 from 和 to 路径之间不存在相对路径，则 path.relative() 方法将返回完整的 to 路径。

在下面的程序中，我们将不同的文件路径传递给 path.relative() 方法的 from 和 to 参数。

const path = require('path');
var path1 = path.relative('C:/Users/Lenovo/Desktop/JavaScript/nodefile.js', "E:/programs/file")
console.log(path1);

输出

在在线编译器 (POSIX) 中执行上述程序后，path.relative() 方法将完整的 'to' 路径返回到输出，因为不存在相对路径。

../../../../../../E:/programs/file

当我们在 WINDOWS 操作系统上执行上述代码时，输出如下：

E:\programs\file

示例

如果 from 和 to 路径都是零长度字符串，则 path.relative() 方法 将返回零长度 字符串。

在下面的示例中，我们将空 字符串 传递给 path.relative() 方法的 from 和 to 参数。

const path = require('path');
var path1 = path.relative('', '');
console.log(path1);

输出

如果我们编译并运行上述程序，则 path.relative() 方法将返回零长度 字符串 到输出，因为没有给出路径。

''

示例

如果我们将不是 字符串 类型的值传递给 from 和 to 参数，则 path.relative() 方法将抛出 TypeError。

在给定的示例中，我们将一个 对象 的实例而不是 字符串 传递给方法的 from 和 to 参数。

const path = require('path');
var path1 = path.relative({}, {});
console.log(path1);

TypeError

正如我们在下面的输出中看到的，path.relative() 方法抛出 TypeError，因为 from 和 to 参数不是 字符串 值。

path.js:39
   throw new ERR_INVALID_ARG_TYPE('path', 'string', path);
   ^
   
TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type object
   at assertPath (path.js:39:11)
   at Object.relative (path.js:1172:5)
   at Object.<anonymous> (/home/cg/root/63a02f1595a95/main.js:3:18)
   at Module._compile (internal/modules/cjs/loader.js:702:30)
   at Object.Module._extensions..js (internal/modules/cjs/loader.js:713:10)
   at Module.load (internal/modules/cjs/loader.js:612:32)
   at tryModuleLoad (internal/modules/cjs/loader.js:551:12)
   at Function.Module._load (internal/modules/cjs/loader.js:543:3)
   at Function.Module.runMain (internal/modules/cjs/loader.js:744:10)
   at startup (internal/bootstrap/node.js:238:19)