corrade-nucleus-nucleons – Blame information for rev 37
?pathlinks?
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 37 | office | 1 | # Maintainer needed |
| 2 | |||
| 3 | This library is no longer actively used at Axinom. It therefore lacks a maintainer who can pay attention to pull requests and issues. If you are an active developer who would like to take over, please open an issue stating your intentions and providing contact information so that the maintainership can be transferred to you. |
||
| 4 | |||
| 5 | # x2js |
||
| 6 | |||
| 7 | This is a library that converts between XML and JavaScript objects. |
||
| 8 | The conversion is not necessarily lossless but it is very convenient. |
||
| 9 | |||
| 10 | [](https://badge.fury.io/js/x2js) |
||
| 11 | |||
| 12 | master | development |
||
| 13 | ------ | ----------- |
||
| 14 | [](https://travis-ci.org/x2js/x2js) | [](https://travis-ci.org/x2js/x2js) |
||
| 15 | |||
| 16 | # Integration |
||
| 17 | |||
| 18 | The code is all contained within the `x2js.js` file, so you can include it directly |
||
| 19 | via a script tag. It will create `window.X2JS`, which is a constructor that can be |
||
| 20 | used to create instances of the converter, providing an optional configuration object. |
||
| 21 | |||
| 22 | In a Node app, `require("x2js")` will give you the constructor that you can use the same way. |
||
| 23 | |||
| 24 | Loading via AMD-capable loaders (e.g. require.js) is also supported and works equivalently. |
||
| 25 | |||
| 26 | The `xmldom` package is a dependency but it is only used under Node, as in browsers the browser DOM is used. |
||
| 27 | |||
| 28 | # Quick start |
||
| 29 | |||
| 30 | ```js |
||
| 31 | var x2js = new X2JS(); |
||
| 32 | var document = x2js.xml2js(xml); |
||
| 33 | |||
| 34 | console.log(document.MyRootElement.ElementX[1].toString()); |
||
| 35 | |||
| 36 | var xml = x2js.js2xml(document); |
||
| 37 | console.log(xml); |
||
| 38 | ``` |
||
| 39 | |||
| 40 | See the type definitions within `x2js.d.ts` for information about what configuration options you can pass. |
||
| 41 | |||
| 42 | # Automated tests |
||
| 43 | |||
| 44 | A set of QUnit test cases are part of the project and act as the primary usage examples. |
||
| 45 | |||
| 46 | Run `karma start --single run` to test with Chrome, Firefox and IE. |
||
| 47 | Run `node_modules\.bin\qunit-cli all_tests.js` to test with the Node runtime. |
||
| 48 | Run `npm test` to execute both sets of tests. |
||
| 49 | |||
| 50 | Travis CI uses `npm travistest` to run tests using Firefox via Karma and Node. |
||
| 51 | |||
| 52 | # Contributing |
||
| 53 | |||
| 54 | Contributions are welcome! To ensure speedy merges, please: |
||
| 55 | |||
| 56 | * base any pull requests on the **development** branch. |
||
| 57 | * ensure that the code passes ESLint validation with the included ruleset. |