在 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!`);
});

若要刪除包含內容的資料夾,請使用fs.rm(),並使用選項{ recursive: true }來遞迴刪除內容。

{ 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!`);
});