write-json    

> Write a JSON file to disk, also creates intermediate directories in the destination path if they don't already exist.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

``sh
$ npm install --save write-json
`

Usage

`js
var writeJson = require('write-json');

// async
writeJson('foo.json', {abc: 'xyz'}, function(err) {
// do stuff with err
});

// sync
writeJson.sync('foo.json', {abc: 'xyz'});
`

API

$3

Calls JSON.stringify on the given value then asynchronously writes the result to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Returns a promise if a callback function is not passed.

Params

* filepath {string}: Destination file path
* value {object}: Value to stringify.
* options {object}: Options to pass to JSON.stringify
* callback {Function}: (optional) If no callback is provided, a promise is returned.
* returns {undefined}

Example

`js
var writeJson = require('write');
var pkg = {name: 'write-json'};

writeJson('foo.json', pkg, function(err) {
if (err) console.log(err);
});

// pass options to JSON.stringify explicitly
writeJson('foo.json', pkg, null, 2, function(err) {
if (err) console.log(err);
});

// pass options to JSON.stringify as an object
// (since this method returns a promise if no callback is passed,
// if you want to pass a replacer function to JSON.stringify, it
// must be passed on an options object)
writeJson('foo.json', pkg, {
indent: 2,
replacer: function(value) {
// filter out properties
if (typeof value === 'string') {
return undefined;
}
return value;
}
}, function(err) {
if (err) console.log(err);
});
`

$3

The promise version of writeFile. Returns a promise.

Params

* filepath {String}: Destination file path
* value {any}: The value to stringify
* options {object}: Options to pass to JSON.stringify
* returns {Promise}

Example

`js
var writeJson = require('write');
writeJson.promise('package.json', {name: 'write-json'})
.then(function() {
// do stuff
});
`

$3

The synchronous version of writeFile. Returns undefined.

Params

* filepath {String}: Destination file path
* value {any}: The value to stringify
* options {object}: Options to pass to JSON.stringify
* returns {undefined}

Example

`js
var writeJson = require('write');
writeJson.sync('package.json', {name: 'write-json'});
`

$3

The stream version of writeFile. Returns a new WriteStream object.

Params

* filepath {string|Buffer|integer}: filepath or file descriptor.
* options {object}: Options to pass to mkdirp and [fs.createWriteStream][fs]{#fs_fs_createwritestream_path_options}
* returns {Stream}: Returns a new WriteStream object. (See Writable Stream).

Example

`js
var fs = require('fs');
var writeJson = require('write');
fs.createReadStream('defaults.json')
.pipe(writeJson.stream('package.json'))
.on('close', function() {
// do stuff
});
`

Release history

$3

Changed

* The main function now returns a promise if no callback is passed

Added

* adds promise support
* adds stream support

$3

Fixed

* Make sure JSON.stringify receives all intended arguments

About

$3

You might also be interested in these projects:

* delete: Delete files and folders and any intermediate directories if they exist (sync and async). | homepage.")
* read-data: Read JSON or YAML files. | homepage
* read-yaml: Very thin wrapper around js-yaml for directly reading in YAML files. | homepage
* write-data: Write a YAML or JSON file to disk. Automatically detects the format to write based… more | ext` on the options."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* write-yaml: Write YAML. Converts JSON to YAML writes it to the specified file. | homepage
* write: Write data to a file, replacing the file if it already exists and creating any… more | homepage

$3

Jon Schlinkert

* linkedin/in/jonschlinkert
* github/jonschlinkert
* twitter/jonschlinkert

$3

Copyright © 2018, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on January 26, 2018._