diff options
Diffstat (limited to 'node_modules/xml2js/README.md')
| -rw-r--r-- | node_modules/xml2js/README.md | 146 |
1 files changed, 99 insertions, 47 deletions
diff --git a/node_modules/xml2js/README.md b/node_modules/xml2js/README.md index 4e01478e9..508b15fd8 100644 --- a/node_modules/xml2js/README.md +++ b/node_modules/xml2js/README.md @@ -21,6 +21,9 @@ Installation Simplest way to install `xml2js` is to use [npm](http://npmjs.org), just `npm install xml2js` which will download xml2js and all dependencies. +xml2js is also available via [Bower](http://bower.io/), just `bower install +xml2js` which will download xml2js and all dependencies. + Usage ===== @@ -81,7 +84,7 @@ fs.readFile(__dirname + '/foo.xml', function(err, data) { Look ma, no event listeners! You can also use `xml2js` from -[CoffeeScript](http://jashkenas.github.com/coffee-script/), further reducing +[CoffeeScript](https://github.com/jashkenas/coffeescript), further reducing the clutter: ```coffeescript @@ -101,27 +104,10 @@ not, we got you covered! Starting with 0.2.8 you can also leave it out, in which case `xml2js` will helpfully add it for you, no bad surprises and inexplicable bugs! -"Traditional" usage -------------------- - -Alternatively you can still use the traditional `addListener` variant that was -supported since forever: - -```javascript -var fs = require('fs'), - xml2js = require('xml2js'); - -var parser = new xml2js.Parser(); -parser.addListener('end', function(result) { - console.dir(result); - console.log('Done.'); -}); -fs.readFile(__dirname + '/foo.xml', function(err, data) { - parser.parseString(data); -}); -``` +Parsing multiple files +---------------------- -If you want to parse multiple files, you have multiple possibilites: +If you want to parse multiple files, you have multiple possibilities: * You can create one `xml2js.Parser` per file. That's the recommended one and is promised to always *just work*. @@ -140,7 +126,7 @@ Displaying results ------------------ You might wonder why, using `console.dir` or `console.log` the output at some -level is only `[Object]`. Don't worry, this is not because xml2js got lazy. +level is only `[Object]`. Don't worry, this is not because `xml2js` got lazy. That's because Node uses `util.inspect` to convert the object into strings and that function stops after `depth=2` which is a bit low for most XML. @@ -171,12 +157,13 @@ var xml = builder.buildObject(obj); At the moment, a one to one bi-directional conversion is guaranteed only for default configuration, except for `attrkey`, `charkey` and `explicitArray` options -you can redefine to your taste. Writing CDATA is not currently supported. +you can redefine to your taste. Writing CDATA is supported via setting the `cdata` +option to `true`. -Processing attribute and tag names ----------------------------------- +Processing attribute, tag names and values +------------------------------------------ -Since 0.4.1 you can optionally provide the parser with attribute and tag name processors: +Since 0.4.1 you can optionally provide the parser with attribute name and tag name processors as well as element value processors (Since 0.4.14, you can also optionally provide the parser with attribute value processors): ```javascript @@ -184,12 +171,20 @@ function nameToUpperCase(name){ return name.toUpperCase(); } -//transform all attribute and tag names to uppercase -parseString(xml, {tagNameProcessors: [nameToUpperCase], attrNameProcessors: [nameToUpperCase]}, function (err, result) { +//transform all attribute and tag names and values to uppercase +parseString(xml, { + tagNameProcessors: [nameToUpperCase], + attrNameProcessors: [nameToUpperCase], + valueProcessors: [nameToUpperCase], + attrValueProcessors: [nameToUpperCase]}, + function (err, result) { + // processed data }); ``` -The `tagNameProcessors` and `attrNameProcessors` options both accept an `Array` of functions with the following signature: +The `tagNameProcessors`, `attrNameProcessors`, `attrValueProcessors` and `valueProcessors` options +accept an `Array` of functions with the following signature: + ```javascript function (name){ //do something with `name` @@ -208,6 +203,12 @@ E.g. 'MyTagName' becomes 'myTagName' - `stripPrefix`: strips the xml namespace prefix. E.g `<foo:Bar/>` will become 'Bar'. (N.B.: the `xmlns` prefix is NOT stripped.) +- `parseNumbers`: parses integer-like strings as integers and float-like strings as floats +E.g. "0" becomes 0 and "15.56" becomes 15.56 + +- `parseBooleans`: parses boolean-like strings to booleans +E.g. "true" becomes true and "False" becomes false + Options ======= @@ -226,8 +227,7 @@ value})``. Possible options are: * `normalize` (default: `false`): Trim whitespaces inside text nodes. * `explicitRoot` (default: `true`): Set this if you want to get the root node in the resulting object. - * `emptyTag` (default: `undefined`): what will the value of empty nodes be. - Default is `{}`. + * `emptyTag` (default: `''`): what will the value of empty nodes be. * `explicitArray` (default: `true`): Always put child nodes in an array if true; otherwise an array is created only if there is more than one. * `ignoreAttrs` (default: `false`): Ignore all XML attributes and only create @@ -246,26 +246,48 @@ value})``. Possible options are: then "children" won't be created. Added in 0.2.5. * `childkey` (default `$$`): Prefix that is used to access child elements if `explicitChildren` is set to `true`. Added in 0.2.5. + * `preserveChildrenOrder` (default `false`): Modifies the behavior of + `explicitChildren` so that the value of the "children" property becomes an + ordered array. When this is `true`, every node will also get a `#name` field + whose value will correspond to the XML nodeName, so that you may iterate + the "children" array and still be able to determine node names. The named + (and potentially unordered) properties are also retained in this + configuration at the same level as the ordered "children" array. Added in + 0.4.9. * `charsAsChildren` (default `false`): Determines whether chars should be considered children if `explicitChildren` is on. Added in 0.2.5. + * `includeWhiteChars` (default `false`): Determines whether whitespace-only + text nodes should be included. Added in 0.4.17. * `async` (default `false`): Should the callbacks be async? This *might* be an incompatible change if your code depends on sync execution of callbacks. - xml2js 0.3 might change this default, so the recommendation is to not - depend on sync execution anyway. Added in 0.2.6. + Future versions of `xml2js` might change this default, so the recommendation + is to not depend on sync execution anyway. Added in 0.2.6. * `strict` (default `true`): Set sax-js to strict or non-strict parsing mode. Defaults to `true` which is *highly* recommended, since parsing HTML which is not well-formed XML might yield just about anything. Added in 0.2.7. - * `attrNameProcessors` (default: `null`): Allows the addition of attribute name processing functions. - Accepts an `Array` of functions with following signature: + * `attrNameProcessors` (default: `null`): Allows the addition of attribute + name processing functions. Accepts an `Array` of functions with following + signature: ```javascript function (name){ //do something with `name` return name } ``` + Added in 0.4.14 + * `attrValueProcessors` (default: `null`): Allows the addition of attribute + value processing functions. Accepts an `Array` of functions with following + signature: + ```javascript + function (name){ + //do something with `name` + return name + } + ``` Added in 0.4.1 - * `tagNameProcessors` (default: `null`):Allows the addition of tag name processing functions. - Accepts an `Array` of functions with following signature: + * `tagNameProcessors` (default: `null`): Allows the addition of tag name + processing functions. Accepts an `Array` of functions with following + signature: ```javascript function (name){ //do something with `name` @@ -273,11 +295,23 @@ value})``. Possible options are: } ``` Added in 0.4.1 + * `valueProcessors` (default: `null`): Allows the addition of element value + processing functions. Accepts an `Array` of functions with following + signature: + ```javascript + function (name){ + //do something with `name` + return name + } + ``` + Added in 0.4.6 Options for the `Builder` class ------------------------------- +These options are specified by ``new Builder({optionName: value})``. +Possible options are: - * `rootName` (default `root`): root element name to be used in case + * `rootName` (default `root` or the root key name): root element name to be used in case `explicitRoot` is `false` or to override the root element name. * `renderOpts` (default `{ 'pretty': true, 'indent': ' ', 'newline': '\n' }`): Rendering options for xmlbuilder-js. @@ -291,6 +325,11 @@ Options for the `Builder` class * `xmldec.standalone` standalone document declaration: true or false * `doctype` (default `null`): optional DTD. Eg. `{'ext': 'hello.dtd'}` * `headless` (default: `false`): omit the XML header. Added in 0.4.3. + * `allowSurrogateChars` (default: `false`): allows using characters from the Unicode + surrogate blocks. + * `cdata` (default: `false`): wrap text nodes in `<![CDATA[ ... ]]>` instead of + escaping when necessary. Does not add `<![CDATA[ ... ]]>` if it is not required. + Added in 0.4.5. `renderOpts`, `xmldec`,`doctype` and `headless` pass through to [xmlbuilder-js](https://github.com/oozcitak/xmlbuilder-js). @@ -309,13 +348,13 @@ var parser = new xml2js.Parser(xml2js.defaults["0.2"]); To get the 0.1 defaults in version 0.2 you can just use `xml2js.defaults["0.1"]` in the same place. This provides you with enough time -to migrate to the saner way of parsing in xml2js 0.2. We try to make the +to migrate to the saner way of parsing in `xml2js` 0.2. We try to make the migration as simple and gentle as possible, but some breakage cannot be avoided. So, what exactly did change and why? In 0.2 we changed some defaults to parse the XML in a more universal and sane way. So we disabled `normalize` and `trim` -so xml2js does not cut out any text content. You can reenable this at will of +so `xml2js` does not cut out any text content. You can reenable this at will of course. A more important change is that we return the root tag in the resulting JavaScript structure via the `explicitRoot` setting, so you need to access the first element. This is useful for anybody who wants to know what the root node @@ -328,16 +367,29 @@ variable amounts of subtags. Running tests, development ========================== -[](https://travis-ci.org/Leonidas-from-XIV/node-xml2js) -[](https://david-dm.org/Leonidas-from-XIV/node-xml2js) +[](https://travis-ci.org/Leonidas-from-XIV/node-xml2js) +[](https://coveralls.io/r/Leonidas-from-XIV/node-xml2js?branch=master) +[](https://david-dm.org/Leonidas-from-XIV/node-xml2js) The development requirements are handled by npm, you just need to install them. We also have a number of unit tests, they can be run using `npm test` directly from the project root. This runs zap to discover all the tests and execute them. -If you like to contribute, keep in mind that xml2js is written in CoffeeScript, -so don't develop on the JavaScript files that are checked into the repository -for convenience reasons. Also, please write some unit test to check your -behaviour and if it is some user-facing thing, add some documentation to this -README, so people will know it exists. Thanks in advance! +If you like to contribute, keep in mind that `xml2js` is written in +CoffeeScript, so don't develop on the JavaScript files that are checked into +the repository for convenience reasons. Also, please write some unit test to +check your behaviour and if it is some user-facing thing, add some +documentation to this README, so people will know it exists. Thanks in advance! + +Getting support +=============== + +Please, if you have a problem with the library, first make sure you read this +README. If you read this far, thanks, you're good. Then, please make sure your +problem really is with `xml2js`. It is? Okay, then I'll look at it. Send me a +mail and we can talk. Please don't open issues, as I don't think that is the +proper forum for support problems. Some problems might as well really be bugs +in `xml2js`, if so I'll let you know to open an issue instead :) + +But if you know you really found a bug, feel free to open an issue instead. |