Promise形式的文件操作

梗概:

1. 导入node:fs/promises
2. 用open()创建FileHandle实例
   1. 执行读写操作完成之后, 一定要记得关闭文件

获取路径信息语法:

stat('路径')

1. 返回值:

返回Stat对象, 具有以下方法与属性:

interface Stat{
	isFile(): boolean;//判断路径是否文件
	isDirectory(): boolean;//判断路径是否是目录
	isBlockDevice(): boolean;
	isCharacterDevice(): boolean;
	isSymbolicLink(): boolean;
	isFIFO(): boolean;
	isSocket(): boolean;
	dev: T;
	ino: T;
	mode: T;
	nlink: T;
	uid: T;
	gid: T;
	rdev: T;
	size: T;
	blksize: T;
	blocks: T;
	atimeMs: T;
	mtimeMs: T;
	ctimeMs: T;
	birthtimeMs: T;
	atime: Date;
	mtime: Date;
	ctime: Date;
	birthtime: Date;
}

文件操作语法:

1. open()

open(目标, 行为[, 模式])

1. 目标 可以是:
   1. 文件的路径
   2. child::Buffer
   3. child::URL
2. 行为 可以是: 打开文件的行为
3. 模式 设置文件模式(权限)，文件创建默认权限为 0666(可读，可写)。

1.1. 注意:

1. 有些文件(如json), 使用w的行为(w或w+)打开, 会清空文件内容
   1. 所以读取的时候, 不要使用w行为打开, 要使用r行为

2. 关闭文件:

filehandle.close()

2.1. 说明:

1. 手动关闭文件, 防止内存泄漏等不安全事情发生
   1. 虽然默认是自动关闭的, 但那是不稳定的

3. 创建流:

3.1. 创建读取流:

filehandle.createReadStream([参数对象])

1. 参数对象是可选的, 有六个属性:
   1. encoding, 默认为null
      1. child::影响流的数据单元
   2. autoClose, 默认为true
   3. emitClose, 默认为true
      1. 创建出来的流被关闭时, 是否会触发'close'事件
   4. start: number, 读取文件的起始字节位置, 包含在内, 默认为当前光标位置
      1. 注意: 不是字符位置, 而是字节
   5. end: number, 读取文件的结束字节位置, 包含在内, 默认为最后一位
   6. highWaterMark: number
      1. child::^3e6bbd

注意:

1. 当读取流发出end事件的时候, 会自动关闭filehandle

3.2. 创建写入流:

filehandle.createWriteStream([参数对象])

1. 参数对象时可选的, 有六个属性:
   1. encoding, 默认为null
      1. child::影响流的数据单元
   2. autoClose, 默认为true
   3. emitClose, 默认为true
   4. start, 默认位置取决于打开的行为

4. 读取Buffer

filehandle.read(buffer, 写入buffer的位置, 读取长度, 读取位置)

1. 读取位置 如果为null, 则为当前光标位置

4.1. 返回值:

Promise对象

1. 传给resolve的是一个对象, 有两个属性:
   1. bytesRead: 读取长度
   2. buffer: 读取出来的buffer

5. 读取字符串:

5.1. 语法一:

filehandle.readFile('编码格式')

5.2. 语法二:

filehandle.readFile(设置对象)

1. 设置对象 有两个属性:
   1. encoding 默认为null
   2. signal 是否允许异常终止

5.3. 说明:

1. 默认从当前光标处开始阅读
2. 每次阅读完, 就会把阅读光标移动到最后
   1. 所以多次调用的话, 只有第一次有返回结果

6. 写入Buffer:

filehandle.write(buffer, buffer的起始位置[, 写入长度[, 写入位置]])

1. 写入长度默认为buffer.byteLength - offset
2. 写入位置 默认为最后

6.1. 返回值:

Promise对象

1. 传给resolve的是一个对象, 有两个属性:
   1. bytesWritten: 写入长度
   2. buffer: 写入的buffer

6.2. 说明:

1. On Linux, positional writes do not work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to the end of the file.

7. 按字节写入字符串:

filehandle.write('字符串'[, 写入位置[, '编码格式']])

1. 写入位置单位为字节, 而不是字符

7.1. 返回值:

Promise对象

1. 传给resolve的是一个对象, 有两个属性:
   1. bytesWritten: 写入长度
   2. buffer: 写入的 string

8. 替换整个文本:

filehandle.writeFile('字符串'或buffer[,{encoding:'编码格式'}])

1. 当写入字符串时, 才需要提供编码格式

目录操作语法:

1. 读取目录的内容

read(路径[, 参数对象])

1. 参数对象有两个参数:
   1. encoding:string, 返回文件名的编码格式
      1. 如果设置位'buffer', 则返回值得文件名就是buffer类型
   2. withFileTypes:boolean, 影响返回数组的元素类型

1.1. 返回值:

返回一个数组, 每一个元素代表了一个文件或目录

1. 如果withFileTypes为真, 则元素为Dirent类型
2. 如果withFileTypes为假, 则元素为string类型, 为目录或文件名(包含拓展名)

1.2. 说明:

1. 只能读取一层
   1. 用递归的方式可以深层读取
2. 常常配合path模块的路径拼接api来获取该目录下的文件路径