parse-json

Functions

• parseJson()

Classes

• JSONError

  • codeFrame
  • fileName
  • rawCodeFrame

Type Aliases

• Reviver

function parseJson

parseJson: {
    (string: string, reviver?: Reviver, filename?: string): JsonObject;
    (string: string, filename?: string): JsonObject;
};

• Parse JSON with more helpful errors.

  Parameter string

  A valid JSON string.

  Parameter reviver

  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.

  Parameter filename

  The filename displayed in the error message.

  Returns

  A parsed JSON object.

  Throws

  A JSONError when there is a parsing error.

  Example 1

  import parseJson, {JSONError} from 'parse-json';
  
  const json = '{\n\t"foo": true,\n}';
  
  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 | }
  //     | ^

• Parse JSON with more helpful errors.

  Parameter string

  A valid JSON string.

  Parameter filename

  The filename displayed in the error message.

  Returns

  A parsed JSON object.

  Throws

  A JSONError when there is a parsing error.

  Example 1

  import parseJson, {JSONError} from 'parse-json';
  
  const json = '{\n\t"foo": true,\n}';
  
  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 | }
  //     | ^

type Reviver

type Reviver = Parameters<(typeof JSON)['parse']>['1'];