當前位置: 首頁>>代碼示例 >>用法及示例精選 >>正文


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大神的英文原創作品 NodeJS fs-extra ensureFile() Function。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。