• 首页 首页 icon
  • 工具库 工具库 icon
    • IP查询 IP查询 icon
  • 内容库 内容库 icon
    • 快讯库 快讯库 icon
    • 精品库 精品库 icon
    • 问答库 问答库 icon
  • 更多 更多 icon
    • 服务条款 服务条款 icon

Nodefs模块的操作API

武飞扬头像
分享前端只知识
帮助1

学新通

这里主要讲一讲node里面fs模块的一些基操!本篇只讲几个API,后续的可能会在其他文章补充!
声明:本文的代码是koa2环境中的,是CommonJS的规范,需要使用require引入!

什么是fs

fs 全称为 file system ,称之为 文件系统 ,是 Node.js 中的 内置模块,直接导入使用即可!

模块中的API,分异步和同步操作,这里不过多解释,主要讲的是异步API、Promise调用,我们只需要做相应的处理即可!

使用方法

官方给了两种使用案例,一种是Promise(使用try、catch包裹) ,另一种是回调。

同步的方法建议使用try、catch包裹!

Promise用法

执行成功一般不会有返回,有返回的会特殊强调,执行失败会抛出异常!

引入的是fs/promises

try、catch

// 注意导入的是 fs/promises 是promises格式的
const { unlink } = require("fs/promises")

try {
  await unlink('/tmp/hello');
  console.log('successfully deleted /tmp/hello');
} catch (error) {
  console.error('there was an error:', error.message);
}

回调用法

一般只有一个回调函数,并且只有一个参数,若执行出错则返回参数有值,否则返回参数无值!

引入的是fs

// 注意直接导入 fs
const { unlink } = require("fs")

unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});

文件夹

文件夹或文件是否存在

fs.existsSync (回调用法)

只有回调用法

// 注意直接导入 fs
const { unlink } = require("fs")
// 返回的值 true 和 false
// 存在就是true
// 不存在就是false
fs.existsSync(path)

新建文件夹

fs.mkdir (Promise用法)

// 注意导入的是 fs/promises 是promises格式的
const { mkdir } = require("fs/promises")
// v10.0.0 以上可用
// 注意 有可选参数option
// option.recursive 是否创建父目录 , true 为创建
// 若option.recursive为false, 但是path中父级路径不存在 会抛出异常

try {
  await mkdir(path,option);
  // 创建成功
} catch (error) {
  // 创建失败
}

删除文件夹

fs.rmdir (Promise用法)

此API注意事项较多,请仔细查看!

// 注意导入的是 fs/promises 是promises格式的
const { rmdir } = require("fs/promises")
// v10.0.0 以上可用
// v14.14.0 以上不建议使用option.recursive 请改为fs.rm
// v16.0.0 以上不能对文件使用、不能对不存在的路径使用
// 注意 有可选参数option (注意版本)
// option.recursive 是否删除子项 , true 为删除

try {
  await rmdir(path,option);
  // 删除成功
} catch (error) {
  // 删除失败
}

文件

删除单个文件

fs.unlink (Promise用法)

// 注意导入的是 fs/promises 是promises格式的
const { unlink } = require("fs/promises")
// v10.0.0 以上可用
// 若path是软连接(类似于快捷方式),则只删除软连接,不影响原本
try {
  await unlink(path);
  // 删除成功
} catch (error) {
  // 删除失败
}

移动(剪贴)、重命名

fs.rename (Promise用法)

// 注意导入的是 fs/promises 是promises格式的
const { rename } = require("fs/promises")
// v10.0.0 以上可用
// oldPath 和 newPath 如只是文件名字不一致,最终类似于重命名,否则就是剪贴移动操作
try {
  await rename(oldPath,newPath)
  // 删除成功
} catch (error) {
  // 删除失败
}

删除文件和目录

类似于 rm -rf 删库跑路,注意使用场景!

fs.rm (Promise用法)

// 注意导入的是 fs/promises 是promises格式的
const { rm } = require("fs/promises")
// v14.14.0 以上可用
// 注意 有可选参数option 
// option.force  如果 path 不存在,则异常将被忽略
// option.recursive 是否递归删除子项 , true 为删除, 在递归模式下,操作将在失败时重试
// option.maxRetries 重试次数 option.recursive为true 有效
// option.retryDelay  重试等待时间 option.recursive为true 有效

try {
  await rm(path,option)
  // 删除成功
} catch (error) {
  // 删除失败
}

学新通

关注公众号了解更多

这篇好文章是转载于:学新通技术网

  • 版权申明: 本站部分内容来自互联网,仅供学习及演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,请提供相关证据及您的身份证明,我们将在收到邮件后48小时内删除。
  • 本站站名: 学新通技术网
  • 本文地址: /boutique/detail/tanhibbhki
系列文章
更多 icon
同类精品
更多 icon
继续加载