Stringify and write JSON to a file atomically
Creates directories for you as needed.
$ npm install write-json-file
import {writeJsonFile} from 'write-json-file';
await writeJsonFile('foo.json', {foo: true});Returns a Promise.
Type: object
Type: string | number | undefined
Default: '\t'
Indentation as a string or number of spaces.
Pass in undefined for no formatting.
If you set both this and detectIndent, this value will be used when the indentation cannot be detected.
Type: boolean
Default: false
Detect indentation automatically if the file exists.
Type: boolean | Function
Default: false
Sort the keys recursively.
Optionally pass in a compare function.
Type: Function
Passed into JSON.stringify.
Type: number
Default: 0o666
The mode used when writing the file.
Available as part of the Tidelift Subscription.
The maintainers of write-json-file and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
- load-json-file - Read and parse a JSON file
- make-dir - Make a directory and its parents if needed
