aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/outputJson-sync.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/outputJson-sync.md
parentaca1143cb9eed16cf37f04e475e4257418dd18ac (diff)
fix build issues and add typedoc
Diffstat (limited to 'node_modules/fs-extra/docs/outputJson-sync.md')
-rw-r--r--node_modules/fs-extra/docs/outputJson-sync.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/outputJson-sync.md b/node_modules/fs-extra/docs/outputJson-sync.md
new file mode 100644
index 000000000..cab6316b5
--- /dev/null
+++ b/node_modules/fs-extra/docs/outputJson-sync.md
@@ -0,0 +1,22 @@
+# outputJsonSync(file, object, [options])
+
+Almost the same as [`writeJsonSync`](writeJson-sync.md), except that if the directory does not exist, it's created.
+`options` are what you'd pass to [`jsonFile.writeFileSync()`](https://github.com/jprichardson/node-jsonfile#writefilesyncfilename-obj-options).
+
+**Alias:** `outputJSONSync()`
+
+- `file` `<String>`
+- `object` `<Object>`
+- `options` `<Object>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.json'
+fs.outputJsonSync(file, {name: 'JP'})
+
+const data = fs.readJsonSync(file)
+console.log(data.name) // => JP
+```