Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 1.41 KB

writeJson.md

File metadata and controls

52 lines (41 loc) · 1.41 KB

writeJson(file, object[, options][, callback])

Writes an object to a JSON file.

Alias: writeJSON()

  • file <String>
  • object <Object>
  • options <Object>
    • spaces <Number> | <String> Number of spaces to indent; or a string to use for indentation (i.e. pass '\t' for tab indentation). See the docs for more info.
    • EOL <String> Set EOL character. Default is \n.
    • replacer JSON replacer
    • Also accepts fs.writeFile() options
  • callback <Function>
    • err <Error>

Example:

const fs = require('fs-extra')

// With a callback:
fs.writeJson('./package.json', {name: 'fs-extra'}, err => {
  if (err) return console.error(err)
  console.log('success!')
})

// With Promises:
fs.writeJson('./package.json', {name: 'fs-extra'})
.then(() => {
  console.log('success!')
})
.catch(err => {
  console.error(err)
})

// With async/await:
async function example () {
  try {
    await fs.writeJson('./package.json', {name: 'fs-extra'})
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

example()

See also: outputJson()