# writejson

> Write stringified object to file

Latest version **3.0.0** (published 2020-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install writejson
pnpm add writejson
yarn add writejson
bun add writejson
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-02-27 |
| First published | 2015-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 1 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | read, parse, json |

## Links

- npm: https://www.npmjs.com/package/writejson
- Repository: https://github.com/coderaiser/node-writejson
- Homepage: https://github.com/coderaiser/node-writejson#readme
- Issues: https://github.com/coderaiser/node-writejson/issues
- npm.io page: https://npm.io/package/writejson

## Dependencies (1)

- [try-catch](https://npm.io/package/try-catch.md) ^3.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 3.0.0 (latest) — 2020-02-27
- 2.0.1 — 2018-06-14
- 2.0.0 — 2018-06-14
- 1.1.2 — 2018-02-09
- 1.1.1 — 2015-12-18
- 1.1.0 — 2015-12-16
- 1.0.1 — 2015-12-15
- 1.0.0 — 2015-12-15

## README

# writejson [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]

Write stringified object to file.

## Install

```
npm i writejson --save
```
## How to use?
To handle formating optional argument `options` could be used according to [JSON.stringify][StringifyURL].

### API

#### writejson(name, object[, options], callback)
Asynchonouse write stringified object.

```js
const writejson = require('writejson');

const [error] = await tryToCatch(writejson, 'data.json', {hello: 'world'});

if (error)
    console.error(error.message);

const options = {
    replacer: ['hello'],    // properties to put in json
    space: 4,               // default space count
    eof: true,              // default new line at end of file
    encoding: 'utf8',       // default
    mode: '0o666',          // default
    flag: 'w',              // default
};

await writejson('data.json', {hello: 'world'}, options);

```
#### writejson.sync(name, object[, options])
Synchonouse write stringified object.

```js
try {
    writejson.sync('data.json', {hello: 'world'});
} catch(error) {
    console.log(error.message);
}
```

#### writejson.sync.try(name, object[, options])
Synchonouse try to write stringified object.

```js
writejson.sync.try('data.json', {hello: 'world'});
```

## License

MIT

[StringifyURL]:             https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[NPMIMGURL]:                https://img.shields.io/npm/v/writejson.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/node-writejson/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/david/coderaiser/node-writejson.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/node-writejson/badge.svg?branch=master&service=github
[NPMURL]:                   https://npmjs.org/package/writejson "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/node-writejson  "Build Status"
[DependencyStatusURL]:      https://david-dm.org/coderaiser/node-writejson "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]:              https://coveralls.io/github/coderaiser/node-writejson?branch=master

---
_Source: https://npm.io/package/writejson · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._