xml2js
Advanced tools
Package description
The xml2js npm package is a library that allows users to convert XML data into a JavaScript object and vice versa. It is useful for working with XML data in a JavaScript environment, such as Node.js applications, where JSON is the more commonly used data format.
Parsing XML to JavaScript Object
This feature allows you to parse XML data and convert it into a JavaScript object. The 'parseString' method takes an XML string and a callback function that receives the parsed result.
const xml2js = require('xml2js');
const parser = new xml2js.Parser();
const xml = '<root>Hello xml2js!</root>';
parser.parseString(xml, (err, result) => {
console.log(result);
});Converting JavaScript Object to XML
This feature enables you to take a JavaScript object and convert it into an XML string. The 'Builder' class is used to create an XML string from the provided object.
const xml2js = require('xml2js');
const builder = new xml2js.Builder();
const obj = { root: 'Hello xml2js!' };
const xml = builder.buildObject(obj);
console.log(xml);Customizing Parser Options
xml2js allows you to customize the behavior of the parser through various options. In this example, 'explicitArray' is set to false to avoid wrapping single elements in an array, and 'trim' is set to true to trim the whitespace from the text nodes.
const xml2js = require('xml2js');
const parser = new xml2js.Parser({
explicitArray: false,
trim: true
});
const xml = '<root> Hello xml2js! </root>';
parser.parseString(xml, (err, result) => {
console.log(result);
});fast-xml-parser is an npm package that provides similar XML parsing and building functionalities as xml2js. It is known for its speed and offers a variety of options for parsing, including the ability to validate XML. It can be a faster alternative to xml2js for large XML files or performance-critical applications.
libxmljs is a Node.js package that binds to the libxml C library. It provides XML parsing and serialization, XPath support, and schema validation. Compared to xml2js, libxmljs is a lower-level library that may offer better performance and more advanced XML processing features but with a more complex API.
xmldom is a W3C standard-compliant DOM parser and serializer for Node.js. It allows you to manipulate XML documents with a DOM API. While xml2js focuses on converting between XML and JavaScript objects, xmldom is more about providing a DOM interface for XML documents, which can be more familiar to developers with experience in web development.
Readme
Simple XML to JavaScript object converter. Uses sax-js.
See the tests for examples until docs are written.
Note: If you're looking for a full DOM parser, you probably want JSDom.
Simplest way to install xml2js is to use npm, just npm install xml2js which will download xml2js and all dependencies.
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);
});
Apart from the default settings, there is a number of options that can be
specified for the parser. Options are specified by new Parser({optionName: value}). Possible options are:
explicitCharkey (default: false)trim (default: true): Trim the whitespace at the beginning and end of
text nodes.normalize (default: true): Trim whitespaces inside text nodes.explicitRoot (default: false): 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 {}.explicitArray (default: false): Always put child nodes in an array if true;
otherwise an array is created only if there is more than one.These default settings are for backward-compatibility (and might change in the
future). For the most 'clean' parsing, you should disable normalize and
trimming and enable explicitRoot.
The development requirements are handled by npm, you just need to install
them. We also have a number of unittests, they can be run using zap
directly from the project root.
FAQs
Simple XML to JavaScript object converter.
The npm package xml2js receives a total of 12,232,122 weekly downloads. As such, xml2js popularity was classified as popular.
We found that xml2js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.