Node.js path.format() 方法

Node.js中的path.format()方法可将路径组件对象格式化成路径字符串。

语法

path.format(pathObject)

• pathObject：必须，包含路径组件的对象。

返回值

返回格式化后的路径字符串。

描述

pathObject对象可包含以下属性：

• root：表示根目录的路径，默认为空字符串。
• dir：表示目录的路径，默认为空字符串。
• base：表示文件名（带扩展名）的路径，默认为空字符串。
• name：表示文件名（不带扩展名）的路径，默认为空字符串。
• ext：表示文件扩展名的路径（包括.符号），默认为空字符串。

pathObject对象必须至少包含dir和base属性。

const path = require('path');

const pathObject = {
  dir: '/Users/johndoe/Documents',
  base: 'example.txt'
};

console.log(path.format(pathObject));
// 输出: /Users/johndoe/Documents/example.txt

示例

示例1：格式化路径对象

const path = require('path');

const pathObject = {
  root: '/',
  dir: '/Users/johndoe/Documents',
  base: 'example.txt',
  ext: '.txt',
  name: 'example'
};

const formattedPath = path.format(pathObject);
// 输出: /Users/johndoe/Documents/example.txt

console.log(formattedPath);

示例2：使用format()方法的结果作为路径变量

const path = require('path');

const pathObject = {
  dir: '/Users/johndoe/Documents',
  base: 'example.txt'
};

const formattedPath = path.format(pathObject);
const newFilePath = path.join(formattedPath, '..', 'newFile');

console.log(newFilePath);
// 输出： /Users/johndoe/newFile

在这个例子中，我们将使用format()方法的结果作为路径变量，并使用join()方法添加..指向上一级目录，然后添加newFile作为新文件名。最终我们得到/Users/johndoe/newFile路径。

注意事项

• 如果pathObject对象只包含root，则返回pathObject.root。
• 如果pathObject对象的dir属性是一个绝对路径，则忽略pathObject.root。
• 如果pathObject对象的base属性为空字符串，则忽略pathObject.ext和pathObject.name。
• 如果pathObject对象的name属性是空字符串，则忽略pathObject.ext。