Parse a string as JSON.
npm install @stdlib/utils-parse-jsonAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var parseJSON = require( '@stdlib/utils-parse-json' );Parses a string as JSON.
var out = parseJSON( '{"beep":"boop"}' );
// returns {'beep':'boop'}If unable to parse a string as JSON, the function returns an error.
var out = parseJSON( 'beep' );
// returns <SyntaxError>To transform the string being parsed, provide a reviver.
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'}-
In contrast to the native
JSON.parse(), this implementation throws aTypeErrorif provided any value which is not astring.var out = JSON.parse( null ); // returns null out = parseJSON( null ); // throws <TypeError>
-
In contrast to the native
JSON.parse(), this implementation does not throw aSyntaxErrorif unable to parse astringas JSON.var out = parseJSON( '{"beep":"boop}' ); // returns <SyntaxError> out = JSON.parse( '{"beep":"boop}' ); // throws <SyntaxError>
-
In contrast to the native
JSON.parse(), this implementation throws aTypeErrorif provided areviverargument which is not afunction.var out = JSON.parse( '{"a":"b"}', [] ); // returns {'a':'b'} out = parseJSON( '{"a":"b"}', [] ); // throws <TypeError>
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>This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
