# readjson

> Read file and parse it as json.

Latest version **2.2.2** (published 2021-01-30) · MIT license · 32.5K weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2021-01-30 |
| First published | 2014-11-28 |
| Weekly downloads | 32.5K |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | read, parse, promise, json |

## Links

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

## Dependencies (2)

- [jju](https://npm.io/package/jju.md) ^1.4.0
- [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

- 2.2.2 (latest) — 2021-01-30
- 2.2.1 — 2021-01-30
- 2.2.0 — 2020-12-22
- 2.1.0 — 2020-12-21
- 2.0.1 — 2020-02-28
- 2.0.0 — 2020-02-28
- 1.1.4 — 2018-02-09
- 1.1.3 — 2015-12-15
- 1.1.2 — 2015-12-15
- 1.1.1 — 2015-09-18
- 1.1.0 — 2015-06-22
- 1.0.2 — 2015-01-09
- 1.0.1 — 2014-12-19
- 1.0.0 — 2014-11-28

## README

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

Read file and parse it as json.

## Install

```
npm i readjson --save
```
## How to use?

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

const json = await readjson('./package.json');

// throws if file not found
readjson.sync('./package.json');

readjson.sync.try('./package.json');
```

## License

MIT

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

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