JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2482654
  • Score
    100M100P100Q197529F
  • License MIT

Stringify and write JSON to a file atomically

Package Exports

  • write-json-file

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (write-json-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

write-json-file Build Status

Stringify and write JSON to a file atomically

Creates directories for you as needed.

Install

$ npm install --save write-json-file

Usage

const writeJsonFile = require('write-json-file');

writeJsonFile('foo.json', {foo: true}).then(() => {
    console.log('done');
});

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.

License

MIT © Sindre Sorhus