write-json-file

Stringify and write JSON to a file atomically

Creates directories for you as needed.

Install

npm install write-json-file

Usage

import {writeJsonFile} from 'write-json-file';

await writeJsonFile('foo.json', {foo: true});

API

writeJsonFile(filePath, data, options?)

Returns a Promise.

writeJsonFileSync(filePath, data, options?)

options

Type: object

indent

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.

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

The 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