Blame view

node_modules/parse-json/readme.md 1.24 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  # parse-json [![Build Status](https://travis-ci.org/sindresorhus/parse-json.svg?branch=master)](https://travis-ci.org/sindresorhus/parse-json)
  
  > Parse JSON with more helpful errors
  
  
  ## Install
  
  ```
  $ npm install parse-json
  ```
  
  
  ## Usage
  
  ```js
  const parseJson = require('parse-json');
  const json = '{\n\t"foo": true,\n}';
  
  
  JSON.parse(json);
  /*
  undefined:3
  }
  ^
  SyntaxError: Unexpected token }
  */
  
  
  parseJson(json);
  /*
  JSONError: Trailing comma in object at 3:1
  }
  ^
  */
  
  
  parseJson(json, 'foo.json');
  /*
  JSONError: Trailing comma in object in foo.json:3:1
  }
  ^
  */
  
  
  // You can also add the filename at a later point
  try {
  	parseJson(json);
  } catch (err) {
  	err.fileName = 'foo.json';
  	throw err;
  }
  /*
  JSONError: Trailing comma in object in foo.json:3:1
  }
  ^
  */
  ```
  
  ## API
  
  ### parseJson(input, [reviver], [filename])
  
  #### input
  
  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`
  
  Filename displayed in the error message.
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)