parse-json

Parse JSON with more helpful errors

MIT 22 个版本
安装
npm install parse-json
yarn add parse-json
pnpm add parse-json
bun add parse-json
README

parse-json

Parse JSON with more helpful errors

Install

npm install parse-json

Usage

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

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


JSON.parse(json);
/*
SyntaxError: Expected double-quoted property name in JSON at position 16 (line 3 column 1)
*/


parseJson(json);
/*
JSONError: Expected double-quoted property name in JSON at position 16 (line 3 column 1)

  1 | {
  2 |   "foo": true,
> 3 | }
    | ^
*/


parseJson(json, 'foo.json');
/*
JSONError: Expected double-quoted property name in JSON at position 16 (line 3 column 1) in foo.json

  1 | {
  2 |   "foo": true,
> 3 | }
    | ^
  fileName: 'foo.json',
  [cause]: SyntaxError: Expected double-quoted property name in JSON at position 16 (line 3 column 1)
      at JSON.parse (<anonymous>)
      at ...
*/


// 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: Expected double-quoted property name in JSON at position 16 (line 3 column 1) in foo.json

  1 | {
  2 |   "foo": true,
> 3 | }
    | ^

  fileName: 'foo.json',
  [cause]: SyntaxError: Expected double-quoted property name in JSON at position 16 (line 3 column 1)
      at JSON.parse (<anonymous>)
      at ...
*/

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

版本列表
8.3.0 2025-04-09
8.2.0 2025-03-21
8.1.0 2023-11-22
8.0.1 2023-11-09
8.0.0 2023-11-02
7.1.1 2023-10-27
7.1.0 2023-09-01
7.0.0 2023-04-07
6.0.2 2021-11-21
6.0.1 2021-11-15
6.0.0 2021-11-04
5.2.0 2021-01-18
5.1.0 2020-08-22
5.0.1 2020-07-24
5.0.0 2019-07-02
4.0.0 2017-11-04
3.0.0 2017-08-17
2.2.0 2015-08-31
2.1.0 2015-08-26
2.0.0 2015-08-25
1.0.1 2015-08-03
1.0.0 2015-07-28