diff options
author | Joel Kronqvist <joel.h.kronqvist@gmail.com> | 2022-03-05 19:02:27 +0200 |
---|---|---|
committer | Joel Kronqvist <joel.h.kronqvist@gmail.com> | 2022-03-05 19:02:27 +0200 |
commit | 5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch) | |
tree | 360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/parse-json/readme.md | |
parent | b500a50f1b97d93c98b36ed9a980f8188d648147 (diff) | |
download | LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip |
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/parse-json/readme.md')
-rw-r--r-- | node_modules/parse-json/readme.md | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/node_modules/parse-json/readme.md b/node_modules/parse-json/readme.md new file mode 100644 index 0000000..5363097 --- /dev/null +++ b/node_modules/parse-json/readme.md @@ -0,0 +1,119 @@ +# 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: 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 parseJson.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` + +Filename displayed in the error message. + +### parseJson.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. + +--- + +<div align="center"> + <b> + <a href="https://tidelift.com/subscription/pkg/npm-parse-json?utm_source=npm-parse-json&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> + </b> + <br> + <sub> + Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. + </sub> +</div> |