📜  Node.js fs-extra outputJson()函数

📅  最后修改于: 2022-05-13 01:56:44.817000             🧑  作者: Mango

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 function
fs.outputJSON(file, object, err => {
  if(err) return console.log(err);
  console.log("Object written to given JSON file");
});


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));


输出:

示例 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