[exp]-fs · Magic_sword2

[TOC] # 简介说明 ``` 版本：fs 作用：文件操作模块 ``` # fs # *open() ***** 异步地打开文件 ### 返回类型 ``` None ``` ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径 * 可选值：[ ] flag: * 类型：字符串 * 默认值：无 * 描述：访问模式 * 可选值：[ ] mode : * 类型：字符串 * 默认值：无 * 描述：访问权限 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` fs.open('./package.json', 'r',function (err, fd) { console.log(fd); }); ``` # *openSync() ***** 同步地打开文件 # *opendir() ***** 异步地打开目录 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径 * 可选值：[ ] options: * 类型：字符串 * 默认值：无 * 描述：可选参数 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] # *opendirSync() ***** 同步地打开目录 # *createReadStream() ***** 创建一个读取文件流stream对象 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：读取的文件路径 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：可选参数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` const fs = require("fs"); let readStream = fs.createReadStream("./README.md", {encoding: 'utf8'}); readStream.on("open", (data) => { console.log('打开了', data) }); readStream.on("data", (data) => { console.log("数据来了！"); console.log(data); console.log("已经读取的字节数", readStream.bytesRead); }); readStream.on("close", (data) => { console.log('guanle') }); console.log(readStream.path + "哈哈哈"); ``` 2. 判断流 ``` const readable = getReadableStreamSomehow(); readable.on('readable', () => { let chunk; while (null !== (chunk = readable.read())) { console.log(`接收到 ${chunk.length} 字节的数据`); } }); ``` # *createWriteStream() ***** 创建一个写入文件流，详见stream ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：写入的文件路径 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：可选参数 * 可选值：[ ] # *appendFile() ***** 异步地将数据追加到文件，如果文件尚不存在则创建该文件 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径，可以是fd，为已经打开的文件追加 * 可选值：[ ] data: * 类型：字符串 * 默认值：无 * 描述：文件数据 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：参数{ encoding | mode | flag } * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` fs.appendFile('message.txt', '追加的数据', (err) => { if (err) throw err; console.log('数据已追加到文件'); }); ``` # *appendFileSync() ***** 同步地将数据追加到文件，如果文件尚不存在则创建该文件 # *write() ***** 异步将 buffer 写入到 fd 指定的文件 # *writeSync() ***** 同步将 buffer 写入到 fd 指定的文件 # *writeFile() ***** 当 file 是一个文件名时，异步地将数据写入到一个文件，如果文件已存在则覆盖该文件 ### 参数说明 file : * 类型：字符串 * 默认值：无 * 描述：文件句柄或文件名 * 可选值：[ ] data : * 类型：buffer * 默认值：无 * 描述：写入的数据 * 可选值：[ ] options: * 类型：对象 * 默认值：无 * 描述：参数选项 * 可选值：[ ] callback: * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] # *writeFileSync() ***** 当 file 是一个文件名时，异步地将数据写入到一个文件，如果文件已存在则覆盖该文件 # *writev() ***** 使用 writev() 将一个 ArrayBufferView 数组异步写入 fd 指定的文件 # *writevSync() ***** 使用 writev() 将一个 ArrayBufferView 数组同步写入 fd 指定的文件 # *read() ***** 异步地读取文件内容 ### 参数说明 fd: * 类型：整型 * 默认值：无 * 描述：文件操作句柄 * 可选值：[ ] buffer : * 类型：buffer * 默认值：无 * 描述：二进制对象 * 可选值：[ ] offset : * 类型：整型 * 默认值：无 * 描述：buffer 中开始写入的偏移量 * 可选值：[ ] length : * 类型：整型 * 默认值：无 * 描述：指定要读取的字节数 * 可选值：[ ] position : * 类型：整型 * 默认值：无 * 描述：指定从文件中开始读取的位置 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] # *readSync() ***** 同步地读取文件内容 # *readdir() ***** 异步读取目录内容 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：读取目录 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：可选参数 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] # *readdirSync() ***** 同步读取目录内容 # *readFile() ***** 异步地读取文件的全部内容。 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径 * 可选值：[ ] options : * 类型：{ encoding: BufferEncoding, flag?: OpenMode } | BufferEncoding * 默认值：无 * 描述：可选参数 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] # *readFileSync() ***** 同步地读取文件的全部内容。 ### 示例内容 1. 举例说明 ``` const fs = require("fs"); var data = fs.readFileSync('./page/index.js'); console.log("同步读取: " + data.toString()); ``` # *readlink() ***** readlink # *readlinkSync() ***** readlinkSync # *access() ***** 测试用户对 path 指定的文件或目录的权限 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径 * 可选值：[ ] mode : * 类型：字符串 * 默认值：无 * 描述：访问模式 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` 不推荐open之前使用access检测，无法保证原子性 const file = 'package.json'; // 检查当前目录中是否存在该文件。 fs.access(file, fs.constants.F_OK, (err) => { console.log(`${file} ${err ? '不存在' : '存在'}`); }); // 检查文件是否可读。 fs.access(file, fs.constants.R_OK, (err) => { console.log(`${file} ${err ? '不可读' : '可读'}`); }); // 检查文件是否可写。 fs.access(file, fs.constants.W_OK, (err) => { console.log(`${file} ${err ? '不可写' : '可写'}`); }); // 检查当前目录中是否存在该文件，以及该文件是否可写。 fs.access(file, fs.constants.F_OK | fs.constants.W_OK, (err) => { if (err) { console.error( `${file} ${err.code === 'ENOENT' ? '不存在' : '只可读'}`); } else { console.log(`${file} 存在，且它是可写的`); } }); ``` # *accessSync() ***** 同步地测试用户对 path 指定的文件或目录的权限 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径 * 可选值：[ ] mode : * 类型：字符串 * 默认值：无 * 描述：访问模式 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` try { fs.accessSync('etc/passwd', fs.constants.R_OK | fs.constants.W_OK); console.log('可以读写'); } catch (err) { console.error('无权访问'); } ``` # *existsSync() ***** 如果传入路径存在，则返回true # *watch() ***** 异步监视 filename 的更改，其中 filename 是文件或目录 # *watchFile() ***** 异步监视 filename 的更改。每当访问文件时都会调用 listener 回调。 # *unwatchFile() ***** 停止监视 filename 的变化 # *utimes() ***** 异步更改 path 指向的对象的文件系统时间戳 # *utimesSync() ***** 同步更改 path 指向的对象的文件系统时间戳 # *realpath() ***** 异步返回绝对路径 # *realpath.native() ***** 异步返回绝对路径 # *realpathSync() ***** 同步返回绝对路径 # *realpathSync.native() ***** 同步返回绝对路径 # *rename() ***** 异步地将 oldPath 上的文件重命名为 newPath 提供的路径名 # *renameSync() ***** 同步地将 oldPath 上的文件重命名为 newPath 提供的路径名 # *rmdir() ***** 异步删除目录 # *rmdirSync() ***** 同步删除目录 # *mkdir() ***** 异步地创建目录 ### 参数说明 path : * 类型：字符串 * 默认值：无 * 描述：文件路径 * 可选值：[ ] options : * 类型：字符串 * 默认值：无 * 描述：可选参数 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` fs.mkdir("./mad/mad", {recursive: true}, function (err) { console.log(err); }); ``` # *mkdirSync() ***** 同步地创建目录 # *mkdtemp() ***** 创建一个唯一的临时目录 ### 参数说明 prefix : * 类型：字符串 * 默认值：无 * 描述：指定前缀 * 可选值：[ ] options : * 类型：对象 * 默认值：无 * 描述：可选参数 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` const fs = require('fs'); fs.mkdtemp("./temp", (err, folder) => { if (err) throw err; console.log(folder); // 打印: /tmp/目录-itXde2 或 C:\Users\...\AppData\Local\Temp\目录-itXde2 }); ``` # *mkdtempSync() ***** 同步创建临时目录，返回创建的目录路径。 # *stat() ***** 异步获取文件信息 # *statSync() ***** 同步获取文件信息 # *truncate() ***** 异步的 truncate(2)。除了可能的异常，完成回调没有其他参数。文件描述符也可以作为第一个参数传入 # *truncateSync() ***** 同步的 truncate(2)。除了可能的异常，完成回调没有其他参数。文件描述符也可以作为第一个参数传入 # *symlink() ***** 异步的 symlink(2)，它会创建名为 path 的链接，该链接指向 target # *symlinkSync() ***** 同步的 symlink(2)，它会创建名为 path 的链接，该链接指向 target # *unlink() ***** 异步地删除文件或符号链接。除了可能的异常，完成回调没有其他参数。 # *unlinkSync() ***** 同步地删除文件或符号链接。除了可能的异常，完成回调没有其他参数。 # *chmod() ***** 异步的更改文件权限 ### *权限附录 1. 举例说明 ![权限附录](images/权限附录.png) # *chmodSync() ***** 同步的更改文件权限 # *chown() ***** 异步地更改文件的所有者和群组 # *chownSync() ***** 同步地更改文件的所有者和群组 # *close() ***** 异步的 close()。除了可能的异常，完成回调没有其他参数。 # *closeSync() ***** 同步的 close()。除了可能的异常，完成回调没有其他参数。 # *copyFile() ***** 异步地将 src 拷贝到 dest。 ### 参数说明 src : * 类型：字符串 * 默认值：无 * 描述：要拷贝的源文件名 * 可选值：[ ] dest : * 类型：字符串 * 默认值：无 * 描述：拷贝操作的目标文件名 * 可选值：[ ] flags : * 类型：对象 * 默认值：无 * 描述：用于拷贝操作的修饰符 * 可选值：[ ] callback : * 类型：fn * 默认值：无 * 描述：回调函数 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` const fs = require('fs'); // 默认情况下将创建或覆盖目标文件。 fs.copyFile('源文件.txt', '目标文件.txt', (err) => { if (err) throw err; console.log('源文件已拷贝到目标文件'); }); ``` # *copyFileSync() ***** 同步地将 src 拷贝到 dest # *fchmod() ***** fchmod # *fchmodSync() ***** fchmodSync # *fchown() ***** fchown # *fchownSync() ***** fchownSync # *fdatasync() ***** fdatasync # *fdatasyncSync() ***** fdatasyncSync # *fstat() ***** fstat # *fstatSync() ***** fstatSync # *fsync() ***** fsync # *fsyncSync() ***** fsyncSync # *ftruncate() ***** ftruncate # *ftruncateSync() ***** ftruncateSync # *futimes() ***** fsyncSync # *futimesSync() ***** futimesSync # *lchmod() ***** lchmod # *lchmodSync() ***** lchmodSync # *lchown() ***** lchmod # *lchownSync() ***** lchmodSync # *lstat() ***** lstat # *lstatSync() ***** lstatSync # *link() ***** link # *linkSync() ***** linkSync