Function readJsonSync

  • Reads a JSON file and then parses it into an object.

    Parameters

    Returns any

    Example

    import * as fs from '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 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

    See

    https://github.com/jprichardson/node-jsonfile#readfilesyncfilename-options

Generated using TypeDoc