node 的 fs 模块 ​

• fs

fs.existsSync(path) ​

• 同步检测路径是否存在
• 返回布尔值
• path : string | url | buffer

fs.unlinkSync(path) ​

• 从文件系统中删除一个名字。如果该名称是文件的最后一个链接，并且没有进程打开该文件，则该文件将被删除。
  • 没引用，没打开，就删除
• 如果名称是文件的最后一个链接，但任何进程仍然打开该文件，则该文件将一直存在，直到引用它的最后一个文件描述符关闭。
  • 没引用，但打开了，等用它的关闭
• 如果名称引用了符号链接，则删除该链接。
  • 引用了链接，就删除链接

fs.rmdirSync(path[, options]) ​

删除一个目录，该目录必须为空。

fs.rmSync(path[, options]) v14.14.0 ​

同步删除文件和目录

• options
  • recursive：默认 false。是否递归删除

fs.readdirSync(path[, options]) ​

读取目录的内容

• options
  • encoding 默认值 utf8。指定编码的字符串。
  • withFileTypes 默认 false。设置为 true，结果将包含fs.Dirent对象。

import { readdirSync } from "node:fs";
import { cwd } from "node:process";
const files = readdirSync(cwd());
console.log(files);
// [ 'fs', 'package.json' ]

const files = readdirSync(cwd(), {
  withFileTypes: true,
});
// [
//   Dirent { name: 'fs', [Symbol(type)]: 2 },
//   Dirent { name: 'package.json', [Symbol(type)]: 1 }
// ]

fs.readFileSync(path[, options]) ​

返回 path 的内容，如果当 path 为目录时，与 fs.readdirSync(path[, options])相同。

• options
  • encoding 默认值 null。
  • flag 默认值 r。

fs.writeFileSync(file, data[, options]) ​

同步写入文件。

fs.writeFile(file, data[, options], callback) ​

异步写入文件，如果文件已存在则替换文件

fs.writeFile(resolve(cwd(), "re.js"), "const a = 'asd';", err => {
  if (err) {
    console.log(err);
  } else {
    console.log("success");
  }
});

fs.copyFileSync(src, dest[, mode]) ​

同步复制文件。复制 src 到 dest

fs.mkdirSync(path[, options]) ​

同步创建目录

mkdirSync(resolve(cwd(), "xxxx/aaaa"), { recursive: true });

fs.mkdir(path[, options], callback) ​

异步创建目录

• options
  • recursive：默认 false。为 true 时创建目录路径

mkdir(resolve(cwd(), "111/ss"), { recursive: true }, (err, pathstr) => {
  console.log(err, pathstr);
});
// null /Users/yomuki/My/Study/js/node/111

fs.statSync(path[, options]) ​

检索路径的fs.Stats。

• options
  • bigint：默认 false。stats 中的数值是否为 bigint.
  • throwIfNoEntry：默认 true。如果不存在文件系统条目，是否会抛出异常，而不是返回 undefined。

fs.lstatSync(path[, options]) ​

检索引用的符号链接路径的 fs.Stats

fs.Stats ​

有关于文件信息的对象。

stats.isDirectory() ​

是否目录。true/false

入参说明 ​

File system flags ​

flag

• 'a'：打开文件进行追加。如果文件不存在，则创建该文件。
• 'ax'：与'a'相似，如果路径存在则失败。
• 'a+'：打开文件进行读取和追加。如果文件不存在，则创建该文件。
• 'ax+'：与'ax+'相似，但如果路径存在则失败。
• 'as+'：以同步模式打开文件进行读取和追加。如果文件不存在，则创建该文件。
• 'r': 打开文件进行阅读。如果文件不存在，则会发生异常。
• 'r+'：打开文件进行读写。如果文件不存在，则会发生异常。
• 'rs+'：以同步方式打开文件进行读写。指示操作系统绕过本地文件系统缓存。
  • 这主要用于在 NFS 挂载上打开文件，因为它允许跳过可能过时的本地缓存。它对 I/O 性能有非常实际的影响，因此除非需要，否则不建议使用此标志。
  • 这不会变成 fs.open()或 fsPromises.open()变成同步阻塞调用。如果需要同步操作， fs.openSync()应该使用类似的东西。
• 'w'：打开文件进行写入。该文件被创建（如果它不存在）或被截断（如果它存在）。
• 'wx': 喜欢'w'但如果路径存在则失败。
• 'w+'：打开文件进行读写。该文件被创建（如果它不存在）或被截断（如果它存在）。
• 'wx+': 喜欢'w+'但如果路径存在则失败。