mirror of
https://github.com/jprichardson/node-fs-extra.git
synced 2025-12-08 20:36:18 +00:00
* improve docs * Update docs/ensureSymlink-sync.md Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com> * Update docs/ensureSymlink.md Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com> * add Error type to docs Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
778 B
778 B
readJsonSync(file[, options])
Reads a JSON file and then parses it into an object.
Alias: readJSONSync()
file<String>options<Object>(the same asjsonFile.readFileSync()options)
Example:
const fs = require('fs-extra')
const packageObj = fs.readJsonSync('./package.json')
console.log(packageObj.version) // => 2.0.0
readJsonSync() can take a throws option set to false and it won't throw if the JSON is invalid. Example:
const fs = require('fs-extra')
const file = '/tmp/some-invalid.json'
const data = '{not valid JSON'
fs.writeFileSync(file, data)
const obj = fs.readJsonSync(file, { throws: false })
console.log(obj) // => null