Socket
Socket
Sign inDemoInstall

write-json-file

Package Overview
Dependencies
9
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    write-json-file

Stringify and write JSON to a file atomically


Version published
Maintainers
1
Install size
111 kB
Created

Readme

Source

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

  • load-json-file - Read and parse a JSON file
  • make-dir - Make a directory and its parents if needed

License

MIT © Sindre Sorhus

Keywords

FAQs

Last updated on 12 Feb 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc