Skip to content

Commit 4271222

Browse files
committed
fix syntax in docs to import v5
1 parent e61516a commit 4271222

File tree

5 files changed

+31
-8
lines changed

5 files changed

+31
-8
lines changed

docs/v5/1.GettingStarted.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Example with no configuration
44

55
```js
6-
const XMLParser = require("fast-xml-parser/v5/XMLParser")
6+
const XMLParser = require("fast-xml-parser/src/v5/XMLParser")
77
const parser = new XMLParser();
88
//read xmlData your own
99
let result = parser.parse(xmlData, true);
@@ -12,7 +12,7 @@ let result = parser.parse(xmlData, true);
1212
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.
1313

1414
```js
15-
const JsObjOutputBuilder = require("fast-xml-parser/v5/OutputBuilders/JsObjBuilder");
15+
const JsObjOutputBuilder = require("fast-xml-parser/src/v5/OutputBuilders/JsObjBuilder");
1616

1717
const parser = new XMLParser({
1818
OutputBuilder: new JsObjOutputBuilder()

docs/v5/3.Options.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ By default `JsObjOutputBuilder` output builder is used with default options.
9090
Example
9191

9292
```js
93-
const XMLParser = require("fast-xml-parse/v5/XMLParser");
94-
const JsObjOutputBuilder = require("fast-xml-parse/v5/OutputBuilders/JsObjBuilder");
95-
const JsArrBuilder = require("fast-xml-parse/v5/OutputBuilders/JsArrBuilder");
96-
const JsMinArrBuilder = require("fast-xml-parse/v5/OutputBuilders/JsMinArrBuilder");
93+
const XMLParser = require("fast-xml-parse/src/v5/XMLParser");
94+
const JsObjOutputBuilder = require("fast-xml-parse/src/v5/OutputBuilders/JsObjBuilder");
95+
const JsArrBuilder = require("fast-xml-parse/src/v5/OutputBuilders/JsArrBuilder");
96+
const JsMinArrBuilder = require("fast-xml-parse/src/v5/OutputBuilders/JsMinArrBuilder");
9797

9898
const xmlData = fs.readFileSync("sample.xml").toString();
9999

docs/v5/5.ValueParsers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Entity and date parsers have to be set.
1212
Example when you don't override default parsers
1313

1414
```js
15-
const JsObjOutputBuilder = require("fast-xml-parser/v5/OutputBuilders/JsObjBuilder");
15+
const JsObjOutputBuilder = require("fast-xml-parser/src/v5/OutputBuilders/JsObjBuilder");
1616

1717
const xmlData = `<root>
1818
<int> 1234 </int>
@@ -44,7 +44,7 @@ Output
4444
But if you override it then it will use sequence in the order you defined.
4545

4646
```js
47-
const JsObjOutputBuilder = require("fast-xml-parser/v5/OutputBuilders/JsObjBuilder");
47+
const JsObjOutputBuilder = require("fast-xml-parser/src/v5/OutputBuilders/JsObjBuilder");
4848

4949
const xmlData = `<root>
5050
<int> 1234 </int>

spec/importTests/package.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"name": "importtests",
3+
"version": "1.0.0",
4+
"description": "",
5+
"main": "v5_spec.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"keywords": [],
10+
"author": "",
11+
"license": "ISC",
12+
"dependencies": {
13+
"fast-xml-parser": "^4.5.0"
14+
}
15+
}

spec/importTests/v5_spec.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
const XMLParser = require("fast-xml-parser/src/v5/XMLParser");
2+
const XMLParser = require("fast-xml-parser/src/v5/XMLParser");
3+
4+
describe("XMLParser", function() {
5+
it("should import v5", function() {
6+
const parser = new XMLParser();
7+
});
8+
});

0 commit comments

Comments
 (0)