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


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


outputJson()函数将对象写入JSON文件。如果用户想将数据写入不存在的文件中,它将由函数本身创建。也可以使用outputJSON()代替outputJson()。

用法:

fs.outputJson(file,object,options,callback)

或者

fs.outputJSON(file,object,options,callback)

参数:

  • file:它是一个包含文件路径的字符串。
  • object:这是一个将被写入文件的对象。
  • options:它是一个对象,其中包含可以传递给函数的可选参数。

1.空格:这是一个数字,用于指定要缩进的空格数或用于缩进的字符串,例如制表符为“ \ t”。



2. EOL:这是换行符。默认情况下,字符为“ \ n”。

3. replacer:这可以是用作字符串化的选定过滤器的函数或数组。如果该值为空或null,则对象的所有属性都包含在字符串中。

4.它还接受fs.writeFile()选项。

  • 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:

index.js

// Requiring module 
import fs from "fs-extra"
  
// This file already 
// exists so function 
// will write onto the file 
const file = "file.json"; 
  
// Object 
// This will be 
// written onto 
// the file 
const object = { 
  name:"GeeksforGeeks", 
  type:"website", 
}; 
  
// Function call 
// Using callback fucntion 
fs.outputJSON(file, object, err => { 
  if(err) return console.log(err); 
  console.log("Object written to given JSON file"); 
});

输出:

范例2:

index.js

// Requiring module 
import fs from "fs-extra"
  
// This file does not 
// exists so function 
// will create file 
// and write data onto it 
const file = "dir/file.json"; 
  
// Object 
// This will be 
// written onto 
// the file 
const object = { 
  name:"GeeksforGeeks", 
  type:"website", 
}; 
  
// Additional options 
const options = { 
  spaces:2, 
  EOL:"\n", 
}; 
  
// Function call 
// Using Promises 
fs.outputJSON(file, object, options) 
  .then(() => console.log("File created and object written successfully")) 
  .catch((e) => console.log(e));

输出:

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

相关用法


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