Skip to content
Stringify and write JSON to a file atomically
JavaScript TypeScript
Branch: master
Clone or download
Latest commit ff4e4b4 Nov 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tidelift tasks Sep 10, 2019
.editorconfig Meta tweaks May 27, 2017
.gitattributes Meta tweaks Aug 27, 2018
.gitignore Add TypeScript definition and require Node.js 6 (#17) Aug 27, 2018
.npmrc
.travis.yml Fix Travis May 21, 2019
index.d.ts Require Node.js 8 May 21, 2019
index.js Respect trailing newline at the end of the file (#27) Jul 30, 2019
index.test-d.ts Require Node.js 8 May 21, 2019
license Meta tweaks May 27, 2017
package.json 4.2.1 Nov 16, 2019
readme.md
test.js Respect trailing newline at the end of the file (#27) Jul 30, 2019

readme.md

write-json-file Build Status

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');

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

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 undefined 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.

write-json-file for enterprise

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.

Related

You can’t perform that action at this time.