From 179fbd2f4c26e71f8b125801e41675ee42bd7209 Mon Sep 17 00:00:00 2001 From: Amit Gupta Date: Sun, 24 Nov 2019 08:06:46 +0530 Subject: [PATCH] [AG] update package details --- README.md | 14 +++++++++++++- docs/CHANGELOG.md | 5 +++++ package-lock.json | 15 ++++++++++----- package.json | 2 +- 4 files changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d8c5e0df..f4ae5f7b 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,7 @@ var tObj = parser.getTraversalObj(xmlData,options); var jsonObj = parser.convertToJson(tObj,options); ``` -You can pass `true` or validation option as 3rd parameter to validate along with parsing which is same as above example. +As you can notice in above code, validator is not embeded with in the parser and expected to be called separately. However, you can pass `true` or validation options as 3rd parameter to the parser to trigger validator internally. It is same as above example. ```js try{ @@ -161,6 +161,18 @@ try{ } ``` +Validator reurns the following object in case of error; +```js +{ + err: { + code: code, + msg: message, + line: lineNumber, + }, +}; +``` + + #### Note: [he](https://www.npmjs.com/package/he) library is used in this example
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 6c2d8afa..db359886 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,8 @@ +3.15.0 / 2019-11-23 + * validaor: improve error messaging + * validator: add line number in case of error + * validator: add more error scenarios to make it more descriptive + 3.14.0 / 2019-10-25 * arrayMode for XML to JS obj parsing diff --git a/package-lock.json b/package-lock.json index eaa77393..f5daf190 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "fast-xml-parser", - "version": "3.14.0", + "version": "3.15.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -2791,7 +2791,8 @@ "ansi-regex": { "version": "2.1.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "aproba": { "version": "1.2.0", @@ -3206,7 +3207,8 @@ "safe-buffer": { "version": "5.1.2", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "safer-buffer": { "version": "2.1.2", @@ -3262,6 +3264,7 @@ "version": "3.0.1", "bundled": true, "dev": true, + "optional": true, "requires": { "ansi-regex": "^2.0.0" } @@ -3305,12 +3308,14 @@ "wrappy": { "version": "1.0.2", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "yallist": { "version": "3.0.3", "bundled": true, - "dev": true + "dev": true, + "optional": true } } }, diff --git a/package.json b/package.json index cafdd8bd..c9bec780 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fast-xml-parser", - "version": "3.14.0", + "version": "3.15.0", "description": "Validate XML or Parse XML to JS/JSON very fast without C/C++ based libraries", "main": "./src/parser.js", "scripts": {