aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/writeJson.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-24 15:10:37 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-24 15:11:17 +0200
commit7a3df06eb573d36142bd1a8e03c5ce8752d300b3 (patch)
tree70bfaea8884c374876f607774850a3a51c0cb381 /node_modules/fs-extra/docs/writeJson.md
parentaca1143cb9eed16cf37f04e475e4257418dd18ac (diff)
fix build issues and add typedoc
Diffstat (limited to 'node_modules/fs-extra/docs/writeJson.md')
-rw-r--r--node_modules/fs-extra/docs/writeJson.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/writeJson.md b/node_modules/fs-extra/docs/writeJson.md
new file mode 100644
index 000000000..0e9c39319
--- /dev/null
+++ b/node_modules/fs-extra/docs/writeJson.md
@@ -0,0 +1,36 @@
+# writeJson(file, object, [options, callback])
+
+Writes an object to a JSON file. `options` are the same that
+you'd pass to [`jsonFile.writeFile()`](https://github.com/jprichardson/node-jsonfile#writefilefilename-options-callback).
+
+**Alias:** `writeJSON()`
+
+- `file` `<String>`
+- `object` `<Object>`
+- `options` `<Object>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+fs.writeJson('./package.json', {name: 'fs-extra'}, err => {
+ if (err) return console.error(err)
+
+ console.log('success!')
+})
+
+// With Promises
+fs.writeJson('./package.json', {name: 'fs-extra'})
+.then(() => {
+ console.log('success!')
+})
+.catch(err => {
+ console.error(err)
+})
+```
+
+---
+
+**See also:** [`outputJson()`](outputJson.md)