aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/outputJson.md
diff options
context:
space:
mode:
authorDimitri Staessens <dimitri@ouroboros.rocks>2019-10-06 21:37:45 +0200
committerDimitri Staessens <dimitri@ouroboros.rocks>2019-10-06 21:37:45 +0200
commit3c51c3be85bb0d1bdb87ea0d6632f1c256912f27 (patch)
treec7ccc8279b12c4f7bdbbb4270d617e48f51722e4 /node_modules/fs-extra/docs/outputJson.md
parent412c104bebc507bea9c94fd53b5bdc4b64cbfe31 (diff)
downloadwebsite-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.tar.gz
website-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.zip
build: Add some required modules for node
Diffstat (limited to 'node_modules/fs-extra/docs/outputJson.md')
-rw-r--r--node_modules/fs-extra/docs/outputJson.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/outputJson.md b/node_modules/fs-extra/docs/outputJson.md
new file mode 100644
index 0000000..7156991
--- /dev/null
+++ b/node_modules/fs-extra/docs/outputJson.md
@@ -0,0 +1,40 @@
+# outputJson(file, object, [options, callback])
+
+Almost the same as [`writeJson`](writeJson.md), except that if the directory does not exist, it's created.
+
+**Alias:** `outputJSON()`
+
+- `file` `<String>`
+- `object` `<Object>`
+- `options` `<Object>`
+ - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info.
+ - `EOL` `<String>` Set EOL character. Default is `\n`.
+ - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter)
+ - Also accepts [`fs.writeFile` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback)
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.json'
+fs.outputJson(file, {name: 'JP'}, err => {
+ console.log(err) // => null
+
+ fs.readJson(file, (err, data) => {
+ if (err) return console.error(err)
+ console.log(data.name) // => JP
+ })
+})
+
+// With Promises:
+fs.outputJson(file, {name: 'JP'})
+.then(() => fs.readJson(file))
+.then(data => {
+ console.log(data.name) // => JP
+})
+.catch(err => {
+ console.error(err)
+})
+```