在 Node.js 中使用文件夹

Node.js 的 fs 核心模块提供了许多方便的方法,可用于处理文件夹。

检查文件夹是否存在

使用 fs.access()(及其基于 Promise 的 fsPromises.access() 对应项)来检查文件夹是否存在,以及 Node.js 是否可以使用其权限访问它。

创建一个新文件夹

使用 fs.mkdir()fs.mkdirSync()fsPromises.mkdir() 创建一个新文件夹。

const fs = require('node:fs');

const folderName = '/Users/joe/test';

try {
  if (!fs.existsSync(folderName)) {
    fs.mkdirSync(folderName);
  }
} catch (err) {
  console.error(err);
}

读取目录的内容

使用 fs.readdir()fs.readdirSync()fsPromises.readdir() 读取目录的内容。

这段代码读取一个文件夹的内容,包括文件和子文件夹,并返回它们的相对路径

const fs = require('node:fs');

const folderPath = '/Users/joe';

fs.readdirSync(folderPath);

您可以获取完整路径

fs.readdirSync(folderPath).map(fileName => {
  return path.join(folderPath, fileName);
});

您还可以过滤结果,仅返回文件,并排除文件夹

const fs = require('node:fs');

const isFile = fileName => {
  return fs.lstatSync(fileName).isFile();
};

fs.readdirSync(folderPath)
  .map(fileName => {
    return path.join(folderPath, fileName);
  })
  .filter(isFile);

重命名文件夹

使用 fs.rename()fs.renameSync()fsPromises.rename() 重命名文件夹。第一个参数是当前路径,第二个参数是新路径

const fs = require('node:fs');

fs.rename('/Users/joe', '/Users/roger', err => {
  if (err) {
    console.error(err);
  }
  // done
});

fs.renameSync() 是同步版本

const fs = require('node:fs');

try {
  fs.renameSync('/Users/joe', '/Users/roger');
} catch (err) {
  console.error(err);
}

fsPromises.rename() 是基于 Promise 的版本

const fs = require('node:fs/promises');

async function example() {
  try {
    await fs.rename('/Users/joe', '/Users/roger');
  } catch (err) {
    console.log(err);
  }
}
example();

删除文件夹

使用 fs.rmdir()fs.rmdirSync()fsPromises.rmdir() 删除文件夹。

const fs = require('node:fs');

fs.rmdir(dir, err => {
  if (err) {
    throw err;
  }

  console.log(`${dir} is deleted!`);
});

要删除包含内容的文件夹,请使用带有 { recursive: true } 选项的 fs.rm() 递归删除内容。

{ recursive: true, force: true } 使在文件夹不存在时忽略异常。

const fs = require('node:fs');

fs.rm(dir, { recursive: true, force: true }, err => {
  if (err) {
    throw err;
  }

  console.log(`${dir} is deleted!`);
});