Node.js - Path.Relative() 方法



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

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

语法

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


 path.relative(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);

类型错误

正如我们在下面的输出中看到的,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)