当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


Node.js fs-extra ensureFile()用法及代码示例


ensureFile()函数确保文件用户正在请求的文件存在。如果文件不存在,该函数将创建一个新文件。即使用户正在请求某个目录中的文件,但是如果该目录不存在,该函数也会在该目录本身中创建目录和文件。如果文件已经存在,将不会被修改。 createFile()是ensureFile()函数的别称,这意味着我们可以使用createFile()函数代替ensureFile(),一切都会正常进行。

用法:

fs.ensureFile(file,callback)

或者

fs.createFile(file,callback)

参数:

  • file:它是一个包含文件路径的字符串。
  • callback:函数完成任务后将调用它。这将导致错误或成功。也可以用Promise代替回调函数。

返回值:它不返回任何东西。

请按照以下步骤实现该函数:

  1. 可以使用以下命令安装该模块:

    npm install fs-extra
  2. 安装模块后,可以使用以下命令检查已安装模块的版本:

    npm ls fs-extra

  3. 使用以下命令创建一个名为index.js的文件,并在文件中需要fs-extra模块:

    const fs = require('fs-extra');
  4. 要运行文件,请在终端中输入以下命令:

    node index.js

项目结构:项目结构如下所示。

范例1:创建一个名为file.txt的文件。我们将在函数中传递此文件

index.js


// Requiring module
const fs = require("fs-extra");
  
// file path
// File already exist
// No modification
// will be done in file
const file = "file.txt";
  
// Function call
// Using callback function
fs.createFile(file, (err) => {
  if (err) return console.log(e);
  console.log("Successfully completed");
});

输出:由于我们早先创建了文件,因此该函数将不会创建新文件,也不会修改文件中包含的数据。

Successfully completed

范例2:这次,我们将传递不存在的文件路径。

index.js


// Requiring module
const fs = require("fs-extra");
  
// file path
// Path contains a directory
// which does not exist
// It will create both
// directory and file
const file = "dir/file.txt";
  
// Function call
// Using Promises
fs.createFile(file)
  .then(() => console.log("Successfully Completed"))
  .catch((err) => console.log(err));

输出:您将观察到,现在创建了一个名为dir的目录,该目录包含一个名为file.txt的文件。

Successfully Completed

参考:https://github.com/jprichardson/node-fs-extra/blob/HEAD/docs/ensureFile.md


相关用法


注:本文由纯净天空筛选整理自pritishnagpal大神的英文原创作品 Node.js fs-extra ensureFile() Function。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。