@types/xml2js

What is @types/xml2js?

@types/xml2js provides TypeScript type definitions for the xml2js library, which is used to parse XML to JavaScript objects and build XML from JavaScript objects.

What are @types/xml2js's main functionalities?

Parsing XML to JavaScript Object

This feature allows you to parse an XML string into a JavaScript object. The code sample demonstrates how to use the xml2js.Parser class to convert an XML string into a JavaScript object.

const xml2js = require('xml2js');
const parser = new xml2js.Parser();
const xml = '<root>Hello xml2js!</root>';
parser.parseString(xml, (err, result) => {
  console.dir(result);
});

Building XML from JavaScript Object

This feature allows you to build an XML string from a JavaScript object. The code sample demonstrates how to use the xml2js.Builder class to convert a JavaScript object into an XML string.

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

This feature allows you to customize the parsing options. The code sample demonstrates how to disable the default behavior of wrapping child nodes in arrays by setting the explicitArray option to false.

const xml2js = require('xml2js');
const parser = new xml2js.Parser({ explicitArray: false });
const xml = '<root><item>Hello xml2js!</item></root>';
parser.parseString(xml, (err, result) => {
  console.dir(result);
});

Other packages similar to @types/xml2js

fast-xml-parser

fast-xml-parser is a fast and lightweight XML parser and builder for JavaScript. It is known for its performance and low memory footprint compared to xml2js. It also provides TypeScript support and similar functionalities for parsing and building XML.

xml-js

xml-js is another library for converting XML to JavaScript objects and vice versa. It offers a more flexible API and additional options for customizing the conversion process. It also supports TypeScript and can be a good alternative to xml2js.

xml2json

xml2json is a library that converts XML to JSON and vice versa. It is simpler and more focused on JSON conversion compared to xml2js. It also provides TypeScript definitions and can be used as a lightweight alternative.

README

Installation

npm install --save @types/xml2js

Summary

This package contains type definitions for xml2js (https://github.com/Leonidas-from-XIV/node-xml2js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/xml2js.

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/node

Credits

These definitions were written by Michel Salib, Jason McNeil, Christopher Currens, Edward Hinkle, Claas Ahlrichs, Grzegorz Redlicki, and Ryan Ling.