merge-json-file

> Merge a JSON file with a JSON object.

Installation

``sh
yarn add merge-json-file
`

`sh
npm install merge-json-file
`

API

$3

#### For existing files:
`ts
import { mergeJSON } from "merge-json-file";

// old-file.json (before):
// {
// "ok": true
// }
//
mergeJSON("old-file.json", { test: 1 });

// old-file.json (after):
// {
// "ok": true,
// "test": 1
// }
//
`

#### For new files:
`ts
import { mergeJSON } from "merge-json-file";

mergeJSON("new-file.json", { test: 1 });

// new-file.json:
// {
// "test": 1
// }
//

`

$3

type Options = {
/**
* Output formatted JSON. Default: true
*/
pretty?: boolean;
/**
* Recursively create parent directories if needed. Default: true
*/
recursive?: boolean;
/**
* Ensure file ends with a newline. Default: true
*/
appendNewline?: boolean;
}
``

Dependencies

- deepmerge: A library for deep (recursive) merging of Javascript objects
- read-json-safe: Read JSON files without try catch
- write-json-safe: Write formatted JSON to a file

Dev Dependencies

- @bconnorwhite/bob: undefined
- @types/mock-fs: TypeScript definitions for mock-fs
- mock-fs: A configurable mock file system. You know, for testing.

License

MIT

Related Packages

- fs-safe: A simple fs wrapper that doesn't throw
- read-json-safe: Read JSON files without try catch
- write-json-safe: Write formatted JSON to a file