1. module jsonfile
   1. function jsonfile.readFile (file, options, callback)
   2. function jsonfile.readFileSync (file, options)
   3. function jsonfile.writeFile (file, obj, options, callback)
   4. function jsonfile.writeFileSync (file, obj, options)
   5. object jsonfile.spaces

module jsonfile

function jsonfile.readFile (file, options, callback)

• description and source-code

  function readFile(file, options, callback) {
    if (callback == null) {
      callback = options
      options = {}
    }
  
    if (typeof options === 'string') {
      options = {encoding: options}
    }
  
    options = options || {}
    var fs = options.fs || _fs
  
    var shouldThrow = true
    // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
    if ('passParsingErrors' in options) {
      shouldThrow = options.passParsingErrors
    } else if ('throws' in options) {
      shouldThrow = options.throws
    }
  
    fs.readFile(file, options, function (err, data) {
      if (err) return callback(err)
  
      data = stripBom(data)
  
      var obj
      try {
        obj = JSON.parse(data, options ? options.reviver : null)
      } catch (err2) {
        if (shouldThrow) {
          err2.message = file + ': ' + err2.message
          return callback(err2)
        } else {
          return callback(null, null)
        }
      }
  
      callback(null, obj)
    })
  }

• example usage

  ...
    // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
    if ('passParsingErrors' in options) {
  shouldThrow = options.passParsingErrors
    } else if ('throws' in options) {
  shouldThrow = options.throws
    }
  
    fs.readFile(file, options, function (err, data) {
  if (err) return callback(err)
  
  data = stripBom(data)
  
  var obj
  try {
    obj = JSON.parse(data, options ? options.reviver : null)
  ...

function jsonfile.readFileSync (file, options)

• description and source-code

  function readFileSync(file, options) {
    options = options || {}
    if (typeof options === 'string') {
      options = {encoding: options}
    }
  
    var fs = options.fs || _fs
  
    var shouldThrow = true
    // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
    if ('passParsingErrors' in options) {
      shouldThrow = options.passParsingErrors
    } else if ('throws' in options) {
      shouldThrow = options.throws
    }
  
    try {
      var content = fs.readFileSync(file, options)
      content = stripBom(content)
      return JSON.parse(content, options.reviver)
    } catch (err) {
      if (shouldThrow) {
        err.message = file + ': ' + err.message
        throw err
      } else {
        return null
      }
    }
  }

• example usage

  ...
  if ('passParsingErrors' in options) {
    shouldThrow = options.passParsingErrors
  } else if ('throws' in options) {
    shouldThrow = options.throws
  }
  
  try {
    var content = fs.readFileSync(file, options)
    content = stripBom(content)
    return JSON.parse(content, options.reviver)
  } catch (err) {
    if (shouldThrow) {
      err.message = file + ': ' + err.message
      throw err
    } else {
  ...

function jsonfile.writeFile (file, obj, options, callback)

• description and source-code

  function writeFile(file, obj, options, callback) {
    if (callback == null) {
      callback = options
      options = {}
    }
    options = options || {}
    var fs = options.fs || _fs
  
    var spaces = typeof options === 'object' && options !== null
      ? 'spaces' in options
      ? options.spaces : this.spaces
      : this.spaces
  
    var str = ''
    try {
      str = JSON.stringify(obj, options ? options.replacer : null, spaces) + '\n'
    } catch (err) {
      if (callback) return callback(err, null)
    }
  
    fs.writeFile(file, str, options, callback)
  }

• example usage

  ...
  var str = ''
  try {
    str = JSON.stringify(obj, options ? options.replacer : null, spaces) + '\n'
  } catch (err) {
    if (callback) return callback(err, null)
  }
  
  fs.writeFile(file, str, options, callback)
  }
  
  function writeFileSync (file, obj, options) {
  options = options || {}
  var fs = options.fs || _fs
  
  var spaces = typeof options === 'object' && options !== null
  ...

function jsonfile.writeFileSync (file, obj, options)

• description and source-code

  function writeFileSync(file, obj, options) {
    options = options || {}
    var fs = options.fs || _fs
  
    var spaces = typeof options === 'object' && options !== null
      ? 'spaces' in options
      ? options.spaces : this.spaces
      : this.spaces
  
    var str = JSON.stringify(obj, options.replacer, spaces) + '\n'
    // not sure if fs.writeFileSync returns anything, but just in case
    return fs.writeFileSync(file, str, options)
  }

• example usage

  ...
  var spaces = typeof options === 'object' && options !== null
    ? 'spaces' in options
    ? options.spaces : this.spaces
    : this.spaces
  
  var str = JSON.stringify(obj, options.replacer, spaces) + '\n'
  // not sure if fs.writeFileSync returns anything, but just in case
  return fs.writeFileSync(file, str, options)
  }
  
  function stripBom (content) {
  // we do this because JSON.parse would convert it to a utf8 string if encoding wasn't specified
  if (Buffer.isBuffer(content)) content = content.toString('utf8')
  content = content.replace(/^\uFEFF/, '')
  return content
  ...