summaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/writeJson.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/writeJson.md')
-rw-r--r--node_modules/fs-extra/docs/writeJson.md39
1 files changed, 0 insertions, 39 deletions
diff --git a/node_modules/fs-extra/docs/writeJson.md b/node_modules/fs-extra/docs/writeJson.md
deleted file mode 100644
index 8e35271..0000000
--- a/node_modules/fs-extra/docs/writeJson.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# writeJson(file, object, [options, callback])
-
-Writes an object to a JSON file.
-
-**Alias:** `writeJSON()`
-
-- `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')
-
-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)