diff options
| author | Florian Dold <florian.dold@gmail.com> | 2017-05-24 15:10:37 +0200 |
|---|---|---|
| committer | Florian Dold <florian.dold@gmail.com> | 2017-05-24 15:11:17 +0200 |
| commit | 7a3df06eb573d36142bd1a8e03c5ce8752d300b3 (patch) | |
| tree | 70bfaea8884c374876f607774850a3a51c0cb381 /node_modules/fs-extra/docs/outputJson.md | |
| parent | aca1143cb9eed16cf37f04e475e4257418dd18ac (diff) | |
fix build issues and add typedoc
Diffstat (limited to 'node_modules/fs-extra/docs/outputJson.md')
| -rw-r--r-- | node_modules/fs-extra/docs/outputJson.md | 37 |
1 files changed, 37 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 000000000..fc6f2fe51 --- /dev/null +++ b/node_modules/fs-extra/docs/outputJson.md @@ -0,0 +1,37 @@ +# outputJson(file, object, [options, callback]) + +Almost the same as [`writeJson`](writeJson.md), except that if the directory does not exist, it's created. +`options` are what you'd pass to [`jsonFile.writeFile()`](https://github.com/jprichardson/node-jsonfile#writefilefilename-options-callback). + +**Alias:** `outputJSON()` + +- `file` `<String>` +- `object` `<Object>` +- `options` `<Object>` +- `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) +}) +``` |
