From 3c51c3be85bb0d1bdb87ea0d6632f1c256912f27 Mon Sep 17 00:00:00 2001
From: Dimitri Staessens <dimitri@ouroboros.rocks>
Date: Sun, 6 Oct 2019 21:37:45 +0200
Subject: build: Add some required modules for node

---
 node_modules/fs-extra/docs/readJson.md | 58 ++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 node_modules/fs-extra/docs/readJson.md

(limited to 'node_modules/fs-extra/docs/readJson.md')

diff --git a/node_modules/fs-extra/docs/readJson.md b/node_modules/fs-extra/docs/readJson.md
new file mode 100644
index 0000000..6edc329
--- /dev/null
+++ b/node_modules/fs-extra/docs/readJson.md
@@ -0,0 +1,58 @@
+# readJson(file, [options, callback])
+
+Reads a JSON file and then parses it into an object. `options` are the same
+that you'd pass to [`jsonFile.readFile`](https://github.com/jprichardson/node-jsonfile#readfilefilename-options-callback).
+
+**Alias:** `readJSON()`
+
+- `file` `<String>`
+- `options` `<Object>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+fs.readJson('./package.json', (err, packageObj) => {
+  if (err) console.error(err)
+
+  console.log(packageObj.version) // => 0.1.3
+})
+
+// Promise Usage
+fs.readJson('./package.json')
+.then(packageObj => {
+  console.log(packageObj.version) // => 0.1.3
+})
+.catch(err => {
+  console.error(err)
+})
+```
+
+---
+
+`readJson()` 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)
+
+fs.readJson(file, { throws: false }, (err, obj) => {
+  if (err) console.error(err)
+
+  console.log(obj) // => null
+})
+
+// Promise Usage
+fs.readJson(file, { throws: false })
+.then(obj => {
+  console.log(obj) // => null
+})
+.catch(err => {
+  console.error(err) // Not called
+})
+```
-- 
cgit v1.2.3