From 42712223112bcdf3b198b4573ca86489cd4d2c5c Mon Sep 17 00:00:00 2001 From: amit kumar gupta Date: Sat, 21 Sep 2024 08:54:39 +0530 Subject: [PATCH] fix syntax in docs to import v5 --- docs/v5/1.GettingStarted.md | 4 ++-- docs/v5/3.Options.md | 8 ++++---- docs/v5/5.ValueParsers.md | 4 ++-- spec/importTests/package.json | 15 +++++++++++++++ spec/importTests/v5_spec.js | 8 ++++++++ 5 files changed, 31 insertions(+), 8 deletions(-) create mode 100644 spec/importTests/package.json create mode 100644 spec/importTests/v5_spec.js diff --git a/docs/v5/1.GettingStarted.md b/docs/v5/1.GettingStarted.md index 8021d10e..43cddc9d 100644 --- a/docs/v5/1.GettingStarted.md +++ b/docs/v5/1.GettingStarted.md @@ -3,7 +3,7 @@ Example with no configuration ```js -const XMLParser = require("fast-xml-parser/v5/XMLParser") +const XMLParser = require("fast-xml-parser/src/v5/XMLParser") const parser = new XMLParser(); //read xmlData your own let result = parser.parse(xmlData, true); @@ -12,7 +12,7 @@ let result = parser.parse(xmlData, true); The default response of parse is built by `JsObjOutputBuilder`. FXP v5 comes with 2 more output builders. And you can set your custom output builder too to customize the output. ```js -const JsObjOutputBuilder = require("fast-xml-parser/v5/OutputBuilders/JsObjBuilder"); +const JsObjOutputBuilder = require("fast-xml-parser/src/v5/OutputBuilders/JsObjBuilder"); const parser = new XMLParser({ OutputBuilder: new JsObjOutputBuilder() diff --git a/docs/v5/3.Options.md b/docs/v5/3.Options.md index b7831a60..28683211 100644 --- a/docs/v5/3.Options.md +++ b/docs/v5/3.Options.md @@ -90,10 +90,10 @@ By default `JsObjOutputBuilder` output builder is used with default options. Example ```js -const XMLParser = require("fast-xml-parse/v5/XMLParser"); -const JsObjOutputBuilder = require("fast-xml-parse/v5/OutputBuilders/JsObjBuilder"); -const JsArrBuilder = require("fast-xml-parse/v5/OutputBuilders/JsArrBuilder"); -const JsMinArrBuilder = require("fast-xml-parse/v5/OutputBuilders/JsMinArrBuilder"); +const XMLParser = require("fast-xml-parse/src/v5/XMLParser"); +const JsObjOutputBuilder = require("fast-xml-parse/src/v5/OutputBuilders/JsObjBuilder"); +const JsArrBuilder = require("fast-xml-parse/src/v5/OutputBuilders/JsArrBuilder"); +const JsMinArrBuilder = require("fast-xml-parse/src/v5/OutputBuilders/JsMinArrBuilder"); const xmlData = fs.readFileSync("sample.xml").toString(); diff --git a/docs/v5/5.ValueParsers.md b/docs/v5/5.ValueParsers.md index 36b3ac19..c8e5446f 100644 --- a/docs/v5/5.ValueParsers.md +++ b/docs/v5/5.ValueParsers.md @@ -12,7 +12,7 @@ Entity and date parsers have to be set. Example when you don't override default parsers ```js -const JsObjOutputBuilder = require("fast-xml-parser/v5/OutputBuilders/JsObjBuilder"); +const JsObjOutputBuilder = require("fast-xml-parser/src/v5/OutputBuilders/JsObjBuilder"); const xmlData = ` 1234 @@ -44,7 +44,7 @@ Output But if you override it then it will use sequence in the order you defined. ```js -const JsObjOutputBuilder = require("fast-xml-parser/v5/OutputBuilders/JsObjBuilder"); +const JsObjOutputBuilder = require("fast-xml-parser/src/v5/OutputBuilders/JsObjBuilder"); const xmlData = ` 1234 diff --git a/spec/importTests/package.json b/spec/importTests/package.json new file mode 100644 index 00000000..c7298bdd --- /dev/null +++ b/spec/importTests/package.json @@ -0,0 +1,15 @@ +{ + "name": "importtests", + "version": "1.0.0", + "description": "", + "main": "v5_spec.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "fast-xml-parser": "^4.5.0" + } +} diff --git a/spec/importTests/v5_spec.js b/spec/importTests/v5_spec.js new file mode 100644 index 00000000..be000806 --- /dev/null +++ b/spec/importTests/v5_spec.js @@ -0,0 +1,8 @@ +const XMLParser = require("fast-xml-parser/src/v5/XMLParser"); +const XMLParser = require("fast-xml-parser/src/v5/XMLParser"); + +describe("XMLParser", function() { + it("should import v5", function() { + const parser = new XMLParser(); + }); +}); \ No newline at end of file