https://github.com/sindresorhus/parse-json

Parse JSON with more helpful errors
https://github.com/sindresorhus/parse-json

Last synced: 7 days ago
JSON representation

Parse JSON with more helpful errors

• Host: GitHub
• URL: https://github.com/sindresorhus/parse-json
• Owner: sindresorhus
• License: mit
• Created: 2015-08-25T14:11:41.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T12:40:10.000Z (9 months ago)
• Last Synced: 2024-11-20T23:00:45.925Z (21 days ago)
• Language: JavaScript
• Size: 45.9 KB
• Stars: 347
• Watchers: 11
• Forks: 35
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-nodejs-cn - parse-json - 有更多错误提示的 JSON 处理工具 (包 / 解析)
• awesome-nodejs - parse-json - Parse JSON with more helpful errors.  (Repository / Object / JSON / JSON Schema)
• awesome-nodejs-cn - parse-json - **star:346** 解析带有更多有用错误的JSON (包 / 解析)
• awesome-nodejs - parse-json - Parse JSON with more helpful errors. (Packages / Parsing)
• awesome-nodejs - parse-json - Parse JSON with more helpful errors - ★ 131 (Parsing)
• awesome-node - parse-json - Parse JSON with more helpful errors. (Packages / Parsing)
• awesome-nodejs-cn - parse-json - JSON更多错误信息提示工具. (目录 / 解析工具)

README

        
# parse-json

> Parse JSON with more helpful errors

## Install

```sh

npm install parse-json

```

## Usage

```js

import parseJson, {JSONError} from 'parse-json';

const json = '{\n\t"foo": true,\n}';

JSON.parse(json);

/*

undefined:3

}

^

SyntaxError: Unexpected token }

*/

parseJson(json);

/*

JSONError: Unexpected token } in JSON at position 16 while parsing near '{      "foo": true,}'

  1 | {

  2 |   "foo": true,

> 3 | }

    | ^

*/

parseJson(json, 'foo.json');

/*

JSONError: Unexpected token } in JSON at position 16 while parsing near '{      "foo": true,}' in foo.json

  1 | {

  2 |   "foo": true,

> 3 | }

    | ^

*/

// You can also add the filename at a later point

try {

	parseJson(json);

} catch (error) {

	if (error instanceof JSONError) {

		error.fileName = 'foo.json';

	}

	throw error;

}

/*

JSONError: Unexpected token } in JSON at position 16 while parsing near '{      "foo": true,}' in foo.json

  1 | {

  2 |   "foo": true,

> 3 | }

    | ^

*/

```

## API

### parseJson(string, reviver?, filename?)

Throws a `JSONError` when there is a parsing error.

#### string

Type: `string`

#### reviver

Type: `Function`

Prescribes how the value originally produced by parsing is transformed, before being returned. See [`JSON.parse` docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter

) for more.

#### filename

Type: `string`

The filename displayed in the error message.

### JSONError

Exposed for `instanceof` checking.

#### fileName

Type: `string`

The filename displayed in the error message.

#### codeFrame

Type: `string`

The printable section of the JSON which produces the error.

#### rawCodeFrame

Type: `string`

The raw version of `codeFrame` without colors.