.. | ||
node_modules | ||
index.js | ||
license | ||
package.json | ||
readme.md |
write-json-file
Stringify and write JSON to a file atomically
Creates directories for you as needed.
Install
$ npm install write-json-file
Usage
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
Default: '\t'
Indentation as a string or number of spaces.
Pass in null
for no formatting.
detectIndent
Type: boolean
Default: false
Detect indentation automatically if the file exists.
sortKeys
Type: boolean
function
Default: false
Sort the keys recursively.
Optionally pass in a compare
function.
replacer
Type: function
Passed into JSON.stringify
.
mode
Type: number
Default: 0o666
Mode used when writing the file.
Related
- load-json-file - Read and parse a JSON file
- make-dir - Make a directory and its parents if needed
License
MIT © Sindre Sorhus