stdlib-js
<summary>
About stdlib...
</summary>
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Parse JSON
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Parse a string as [JSON][json].
bash
npm install @stdlib/utils-parse-json
javascript
var parseJSON = require( '@stdlib/utils-parse-json' );
#### parseJSON( str[, reviver] )
Parses a string as [JSON][json].
javascript
var out = parseJSON( '{"beep":"boop"}' );
// returns {'beep':'boop'}
If unable to parse a string as [JSON][json], the function returns an error.
javascript
var out = parseJSON( 'beep' );
// returns <SyntaxError>
To transform the string being parsed, provide a reviver.
javascript
function reviver( key, value ) {
if ( key === '' ) {
return value;
}
if ( key === 'beep' ) {
return value;
}
}
var str = '{"beep":"boop","a":"b"}';
var out = parseJSON( str, reviver );
// returns {'beep':'boop'}
JSON.parse()][json-parse], this implementation throws a TypeError if provided any value which is not a string.
javascript
var out = JSON.parse( null );
// returns null
out = parseJSON( null );
// throws <TypeError>
- In contrast to the native [JSON.parse()][json-parse], this implementation does not throw a SyntaxError if unable to parse a string as [JSON][json].
javascript
var out = parseJSON( '{"beep":"boop}' );
// returns <SyntaxError>
out = JSON.parse( '{"beep":"boop}' );
// throws <SyntaxError>
- In contrast to the native [JSON.parse()][json-parse], this implementation throws a TypeError if provided a reviver argument which is not a function.
javascript
var out = JSON.parse( '{"a":"b"}', [] );
// returns {'a':'b'}
out = parseJSON( '{"a":"b"}', [] );
// throws <TypeError>
javascript
var parseJSON = require( '@stdlib/utils-parse-json' );
var out;
out = parseJSON( '{"beep":"boop"}' );
// returns {'beep':'boop'}
out = parseJSON( '3.14' );
// returns 3.14
out = parseJSON( 'true' );
// returns true
out = parseJSON( 'null' );
// returns null
out = parseJSON( '{"beep":"boop}' );
// returns <SyntaxError>
