一、模块功能
fs
模块是 Node.js 中的一个核心模块,用于在 Node.js 应用程序中执行文件系统操作。它提供了一系列 API 来与文件系统进行交互,比如读写文件、创建目录、读取目录内容、更改文件权限等。fs
模块支持同步和异步两种操作方式,以适应不同的使用场景。
二、模块方法
1、新建文件夹
fs.mkdir("./log", (err)=>{
console.log(err);
});
2、 重命名文件夹
fs.rename("./log1", "./log12", (err) => {
console.log(err);
});
3、删除文件夹
fs.rmdir("./log12", (err) => {
console.log(err);
});
4、写入文件
fs.writeFile("./log1.txt", "Hello asdasdasdasdx", (err) => {
console.log(err);
})
5、追加文件
fs.appendFile("./log1.txt", "\nHello asdasdasdasdx", (err) => {
console.log(err);
})
6、异步读取文件
fs.readFile('log.txt', 'utf-8', (err, data) => {
if (err) {
console.error('读取文件出错:', err);
return;
}
console.log('读取的文件数据为', data);
});
7、同步读取文件
try {
const files = fs.readdirSync('new_directory');
console.log('Directory contents:', files);
} catch (err) {
console.error('Error reading directory:', err);
}
每个都一一列举不太方便,我在这直接将方法给列出来,自行查看。
序号 | 方法 & 描述 |
---|---|
1 | fs.rename(oldPath, newPath, callback) 异步 rename().回调函数没有参数,但可能抛出异常。 |
2 | fs.ftruncate(fd, len, callback) 异步 ftruncate().回调函数没有参数,但可能抛出异常。 |
3 | fs.ftruncateSync(fd, len) 同步 ftruncate() |
4 | fs.truncate(path, len, callback) 异步 truncate().回调函数没有参数,但可能抛出异常。 |
5 | fs.truncateSync(path, len) 同步 truncate() |
6 | fs.chown(path, uid, gid, callback) 异步 chown().回调函数没有参数,但可能抛出异常。 |
7 | fs.chownSync(path, uid, gid) 同步 chown() |
8 | fs.fchown(fd, uid, gid, callback) 异步 fchown().回调函数没有参数,但可能抛出异常。 |
9 | fs.fchownSync(fd, uid, gid) 同步 fchown() |
10 | fs.lchown(path, uid, gid, callback) 异步 lchown().回调函数没有参数,但可能抛出异常。 |
11 | fs.lchownSync(path, uid, gid) 同步 lchown() |
12 | fs.chmod(path, mode, callback) 异步 chmod().回调函数没有参数,但可能抛出异常。 |
13 | fs.chmodSync(path, mode) 同步 chmod(). |
14 | fs.fchmod(fd, mode, callback) 异步 fchmod().回调函数没有参数,但可能抛出异常。 |
15 | fs.fchmodSync(fd, mode) 同步 fchmod(). |
16 | fs.lchmod(path, mode, callback) 异步 lchmod().回调函数没有参数,但可能抛出异常。Only available on Mac OS X. |
17 | fs.lchmodSync(path, mode) 同步 lchmod(). |
18 | fs.stat(path, callback) 异步 stat(). 回调函数有两个参数 err, stats,stats 是 fs.Stats 对象。 |
19 | fs.lstat(path, callback) 异步 lstat(). 回调函数有两个参数 err, stats,stats 是 fs.Stats 对象。 |
20 | fs.fstat(fd, callback) 异步 fstat(). 回调函数有两个参数 err, stats,stats 是 fs.Stats 对象。 |
21 | fs.statSync(path) 同步 stat(). 返回 fs.Stats 的实例。 |
22 | fs.lstatSync(path) 同步 lstat(). 返回 fs.Stats 的实例。 |
23 | fs.fstatSync(fd) 同步 fstat(). 返回 fs.Stats 的实例。 |
24 | fs.link(srcpath, dstpath, callback) 异步 link().回调函数没有参数,但可能抛出异常。 |
25 | fs.linkSync(srcpath, dstpath) 同步 link(). |
26 | fs.symlink(srcpath, dstpath[, type], callback) 异步 symlink().回调函数没有参数,但可能抛出异常。 type 参数可以设置为 'dir', 'file', 或 'junction' (默认为 'file') 。 |
27 | fs.symlinkSync(srcpath, dstpath[, type]) 同步 symlink(). |
28 | fs.readlink(path, callback) 异步 readlink(). 回调函数有两个参数 err, linkString。 |
29 | fs.realpath(path[, cache], callback) 异步 realpath(). 回调函数有两个参数 err, resolvedPath。 |
30 | fs.realpathSync(path[, cache]) 同步 realpath()。返回绝对路径。 |
31 | fs.unlink(path, callback) 异步 unlink().回调函数没有参数,但可能抛出异常。 |
32 | fs.unlinkSync(path) 同步 unlink(). |
33 | fs.rmdir(path, callback) 异步 rmdir().回调函数没有参数,但可能抛出异常。 |
34 | fs.rmdirSync(path) 同步 rmdir(). |
35 | fs.mkdir(path[, mode], callback) S异步 mkdir(2).回调函数没有参数,但可能抛出异常。 访问权限默认为 0777。 |
36 | fs.mkdirSync(path[, mode]) 同步 mkdir(). |
37 | fs.readdir(path, callback) 异步 readdir(3). 读取目录的内容。 |
38 | fs.readdirSync(path) 同步 readdir().返回文件数组列表。 |
39 | fs.close(fd, callback) 异步 close().回调函数没有参数,但可能抛出异常。 |
40 | fs.closeSync(fd) 同步 close(). |
41 | fs.open(path, flags[, mode], callback) 异步打开文件。 |
42 | fs.openSync(path, flags[, mode]) 同步 version of fs.open(). |
43 | fs.utimes(path, atime, mtime, callback) |
44 | fs.utimesSync(path, atime, mtime) 修改文件时间戳,文件通过指定的文件路径。 |
45 | fs.futimes(fd, atime, mtime, callback) |
46 | fs.futimesSync(fd, atime, mtime) 修改文件时间戳,通过文件描述符指定。 |
47 | fs.fsync(fd, callback) 异步 fsync.回调函数没有参数,但可能抛出异常。 |
48 | fs.fsyncSync(fd) 同步 fsync. |
49 | fs.write(fd, buffer, offset, length[, position], callback) 将缓冲区内容写入到通过文件描述符指定的文件。 |
50 | fs.write(fd, data[, position[, encoding]], callback) 通过文件描述符 fd 写入文件内容。 |
51 | fs.writeSync(fd, buffer, offset, length[, position]) 同步版的 fs.write()。 |
52 | fs.writeSync(fd, data[, position[, encoding]]) 同步版的 fs.write(). |
53 | fs.read(fd, buffer, offset, length, position, callback) 通过文件描述符 fd 读取文件内容。 |
54 | fs.readSync(fd, buffer, offset, length, position) 同步版的 fs.read. |
55 | fs.readFile(filename[, options], callback) 异步读取文件内容。 |
56 | fs.readFileSync(filename[, options]) |
57 | fs.writeFile(filename, data[, options], callback) 异步写入文件内容。 |
58 | fs.writeFileSync(filename, data[, options]) 同步版的 fs.writeFile。 |
59 | fs.appendFile(filename, data[, options], callback) 异步追加文件内容。 |
60 | fs.appendFileSync(filename, data[, options]) The 同步 version of fs.appendFile. |
61 | fs.watchFile(filename[, options], listener) 查看文件的修改。 |
62 | fs.unwatchFile(filename[, listener]) 停止查看 filename 的修改。 |
63 | fs.watch(filename[, options][, listener]) 查看 filename 的修改,filename 可以是文件或目录。返回 fs.FSWatcher 对象。 |
64 | fs.exists(path, callback) 检测给定的路径是否存在。 |
65 | fs.existsSync(path) 同步版的 fs.exists. |
66 | fs.access(path[, mode], callback) 测试指定路径用户权限。 |
67 | fs.accessSync(path[, mode]) 同步版的 fs.access。 |
68 | fs.createReadStream(path[, options]) 返回ReadStream 对象。 |
69 | fs.createWriteStream(path[, options]) 返回 WriteStream 对象。 |
70 | fs.symlink(srcpath, dstpath[, type], callback) 异步 symlink().回调函数没有参数,但可能抛出异常。 |