README
write-json5-file
Stringify and write JSON to a file atomically
Installation
<npm|yarn|pnpm> add write-json5-file
Usage
const writeJson5File = require('write-json5-file')
writeJson5File('foo.json5', {foo: true}).then(() => {
console.log('done')
})
API
writeJson5File(filepath, data, [options])
Returns a promise.
writeJson5File.sync(filepath, data, [options])
options
indent
Type: string, number
Default: \t
Indentation as a string or number of spaces.
Pass in null for no formatting.
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 438 (0666 in octal)
Mode used when writing the file.
Related
- read-json5-file - Read and parse a JSON5 file
- write-json-file - Stringify and write JSON to a file atomically
- json5 - JSON for the ES5 era