diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-05-28 00:38:50 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-05-28 00:40:43 +0200 |
commit | 7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch) | |
tree | 6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/write-json-file/readme.md | |
parent | 963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff) |
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/write-json-file/readme.md')
-rw-r--r-- | node_modules/write-json-file/readme.md | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/node_modules/write-json-file/readme.md b/node_modules/write-json-file/readme.md new file mode 100644 index 000000000..ab9162889 --- /dev/null +++ b/node_modules/write-json-file/readme.md @@ -0,0 +1,83 @@ +# write-json-file [](https://travis-ci.org/sindresorhus/write-json-file) + +> Stringify and write JSON to a file [atomically](https://github.com/npm/write-file-atomic) + +Creates directories for you as needed. + + +## Install + +``` +$ npm install --save write-json-file +``` + + +## Usage + +```js +const writeJsonFile = require('write-json-file'); + +writeJsonFile('foo.json', {foo: true}).then(() => { + console.log('done'); +}); +``` + + +## API + +### writeJsonFile(filepath, data, [options]) + +Returns a `Promise`. + +### writeJsonFile.sync(filepath, data, [options]) + +#### options + +Type: `Object` + +##### indent + +Type: `string` `number`<br> +Default: `\t` + +Indentation as a string or number of spaces.<br> +Pass in `null` for no formatting. + +##### detectIndent + +Type: `boolean`<br> +Default: `false` + +Detect indentation automatically if the file exists. + +##### sortKeys + +Type: `boolean` `function`<br> +Default: `false` + +Sort the keys recursively.<br> +Optionally pass in a [`compare`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) function. + +##### replacer + +Type: `function` + +Passed into [`JSON.stringify`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter). + +##### mode + +Type: `number`<br> +Default: `0o666` + +[Mode](https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) used when writing the file. + + +## Related + +- [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file +- [make-dir](https://github.com/sindresorhus/make-dir) - Make a directory and its parents if needed + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |