# utils-json-parse

> Wraps JSON#parse in a try/catch block.

Latest version **1.0.0** (published 2015-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install utils-json-parse
pnpm add utils-json-parse
yarn add utils-json-parse
bun add utils-json-parse
```

## 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 | 1.0.0 |
| Published | 2015-08-18 |
| First published | 2015-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Athan Reines |
| Maintainers | kgryte |
| Keywords | utils, util, utilities, utility, json, parse, try, trap, catch |

## Links

- npm: https://www.npmjs.com/package/utils-json-parse
- Repository: https://github.com/kgryte/utils-json-parse
- Homepage: https://github.com/kgryte/utils-json-parse#readme
- Issues: https://github.com/kgryte/utils-json-parse/issues
- npm.io page: https://npm.io/package/utils-json-parse

## 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

- 1.0.0 (latest) — 2015-08-18
- 0.0.0 — 2015-08-18

## README

JSON#parse
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]

> Wraps [JSON#parse](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse) in a try/catch block.


## Installation

``` bash
$ npm install utils-json-parse
```


## Usage

``` javascript
var parse = require( 'utils-json-parse' );
```

#### parse( value[, reviver] )

Wraps [`JSON#parse`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse) in a `try/catch` block.

``` javascript
var out = parse( '{"beep":"boop"}' );
// returns {'beep':'boop'}

out = parse( '{beep:boop"}' );
// returns <SyntaxError>
```

The API is the same as [`JSON#parse`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse). Hence, to use a custom `reviver` function

``` javascript
var out;

function reviver( key, value ) {
	if ( key === '' ) {
		return value;
	}
	if ( key === 'beep' ) {
		return value;
	}
}

out = parse( '{"beep":"boop","a":"b"}', reviver );
// returns {'beep':'boop'}
```


## Notes

*	This is provided as a standalone module to trap errors encountered while parsing values of unknown type (e.g., HTTP responses from 3rd party APIs) and to isolate the `try/catch` block.
*	The presence of `try/catch` within any `function` prevents JavaScript compiler optimization. By isolating the `try/catch` block, we minimize the extent of optimization hell.


## Examples

``` javascript
var request = require( 'request' ),
	parse = require( 'utils-json-parse' );

function onResponse( error, response, body ) {
	var out;
	if ( error ) {
		return done( error );
	}
	out = parse( body );
	if ( out instanceof Error ) {
		return done( out );
	}
	return done( null, out );
}

function done( error, data ) {
	if ( error ) {
		return console.error( error.message );
	}
	console.log( data );
}

request({
	'method': 'GET',
	'url': 'http://example.com'
}, onResponse );
```

To run the example code from the top-level application directory,

``` bash
$ node ./examples/index.js
```


## Tests

### Unit

Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
```

All new feature development should have corresponding unit tests to validate correct functionality.


### Test Coverage

This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash
$ make test-cov
```

Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,

``` bash
$ make view-cov
```


---
## License

[MIT license](http://opensource.org/licenses/MIT).


## Copyright

Copyright &copy; 2015. Athan Reines.


[npm-image]: http://img.shields.io/npm/v/utils-json-parse.svg
[npm-url]: https://npmjs.org/package/utils-json-parse

[travis-image]: http://img.shields.io/travis/kgryte/utils-json-parse/master.svg
[travis-url]: https://travis-ci.org/kgryte/utils-json-parse

[codecov-image]: https://img.shields.io/codecov/c/github/kgryte/utils-json-parse/master.svg
[codecov-url]: https://codecov.io/github/kgryte/utils-json-parse?branch=master

[dependencies-image]: http://img.shields.io/david/kgryte/utils-json-parse.svg
[dependencies-url]: https://david-dm.org/kgryte/utils-json-parse

[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/utils-json-parse.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/utils-json-parse

[github-issues-image]: http://img.shields.io/github/issues/kgryte/utils-json-parse.svg
[github-issues-url]: https://github.com/kgryte/utils-json-parse/issues

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