node入门之基础API：fs

官方解释：

fs 模块提供了一个 API，用于以模仿标准 POSIX 函数的方式与文件系统进行交互。

要使用此模块：

const fs = require('fs');

所有文件系统操作都具有同步和异步的形式。

异步的形式总是将完成回调作为其最后一个参数。 传给完成回调的参数取决于具体方法，但第一个参数始终预留用于异常。 如果操作成功完成，则第一个参数将为 null 或 undefined。

使用同步的操作发生的异常会立即抛出，可以使用 try/catch 处理，也可以允许冒泡。

fs.readFile 读取文件

注意：一般我们都会采用异步读取数据，如果采用同步，在高并发的情况下，会将请求堵塞。

fs.writeFile()：

异步地将数据写入到一个文件，如果文件已存在则覆盖该文件。 data 可以是字符串或 buffer。

如果 data 是一个 buffer，则 encoding 选项会被忽略。

在同一个文件上多次使用 fs.writeFile() 且不等待回调是不安全的。 对于这种情况，建议使用 fs.createWriteStream()。

fs.Stats 类：

fs.Stats 对象提供有关文件的信息。

从 fs.stat()、fs.lstat() 和 fs.fstat() 及其同步方法返回的对象都属于此类型。 如果传给这些方法的 options 中的 bigint 为 true，则数值将为 bigint 型而不是 number 型。

fs.rename()：

异步地将 oldPath 上的文件重命名为 newPath 提供的路径名。 如果 newPath 已存在，则覆盖它。 除了可能的异常，完成回调没有其他参数。

fs.unlink()：

异步地删除文件或符号链接。 除了可能的异常，完成回调没有其他参

fs.readdir()： 

读取目录的内容。 回调有两个参数 (err, files)，其中 files 是目录中的文件名的数组（不包括 '.' 和 '..'）。

可选的 options 参数可以是指定编码的字符串，也可以是具有 encoding 属性的对象，该属性指定用于传给回调的文件名的字符编码。 如果 encoding 设置为 'buffer'，则返回的文件名是 Buffer 对象。

fs.mkdir():

异步地创建目录。 除了可能的异常，完成回调没有其他参数。

fs.rmdir()：删除文件夹(详见node官方文档)

fs.watch():监听文件夹变化(详见node官方文档)

fs.createReadStream()：读取文件流(详见node官方文档)

fs.createWriteStream()：写入文件流(详见node官方文档)

util.promisify(original)

让一个遵循异常优先的回调风格的函数， 即 (err, value) => ... 回调函数是最后一个参数, 返回一个返回值是一个 promise 版本的函数。

例如：

const util = require('util');
const fs = require('fs');

const stat = util.promisify(fs.stat);
stat('.').then((stats) => {
  // Do something with `stats`
}).catch((error) => {
  // Handle the error.
});

或者，使用async function获得等效的效果:

const util = require('util');
const fs = require('fs');

const stat = util.promisify(fs.stat);

async function callStat() {
  const stats = await stat('.');
  console.log(`This directory is owned by ${stats.uid}`);
}

如果原本就有 original[util.promisify.custom] 属性, promisify 会返回它的值， 查阅 Custom promisified functions.

promisify() 会在所有情况下假定 original 是一个最后的参数是回调函数的函数，如果它不是，那么返回的函数的返回值为 undefined。