diff options
Diffstat (limited to 'node_modules/fs-extra/docs/readJson-sync.md')
| -rw-r--r-- | node_modules/fs-extra/docs/readJson-sync.md | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/node_modules/fs-extra/docs/readJson-sync.md b/node_modules/fs-extra/docs/readJson-sync.md deleted file mode 100644 index a135637..0000000 --- a/node_modules/fs-extra/docs/readJson-sync.md +++ /dev/null @@ -1,33 +0,0 @@ -# readJsonSync(file, [options]) - -Reads a JSON file and then parses it into an object. `options` are the same -that you'd pass to [`jsonFile.readFileSync`](https://github.com/jprichardson/node-jsonfile#readfilesyncfilename-options). - -**Alias:** `readJSONSync()` - -- `file` `<String>` -- `options` `<Object>` - -## Example: - -```js -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: - -```js -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 -``` |