Package Exports

@stdlib/utils-parse-json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-parse-json) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Parse JSON

Parse a string as JSON.

Installation

npm install @stdlib/utils-parse-json

Usage

var parseJSON = require( '@stdlib/utils-parse-json' );

parseJSON( str[, reviver] )

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'}

Notes

In contrast to the native JSON.parse(), this implementation throws a TypeError if provided any value which is not a string.
```
var out = JSON.parse( null );
// returns null

out = parseJSON( null );
// throws <TypeError>
```

In contrast to the native JSON.parse(), this implementation does not throw a SyntaxError if unable to parse a string as 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 a TypeError if provided a reviver argument which is not a function.

var out = JSON.parse( '{"a":"b"}', [] );
// returns {'a':'b'}

out = parseJSON( '{"a":"b"}', [] );
// throws <TypeError>

Examples

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>

Notice

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.

License

See LICENSE.

@stdlib/utils-parse-json