xformatting
TypeScript icon, indicating that this package has built-in type declarations

2.2.0 • Public • Published

<xformatting/>

Issues Travis


Formats XML into a more readable format by inserting linebreaks and indents. Supports all element types (e.g. processing instructions) and also the xml:space attribute

Installation

$ npm install -S xformatting

Usage

Synchronous

const { formatSync } = require('xformatting');

const xml = '<xformatting><code xml:space="preserve">var hello = "world"</code></xformatting>';
const formattedXml = formatSync(xml);
console.log(formattedXml);

Asynchronous

const { format } = require('xformatting');

const xml = '<xformatting><code xml:space="preserve">var hello = "world"</code></xformatting>';
format(xml).then((formattedXml) => {
	console.log(formattedXml);
});

Options

You can pass an options object to the methods as a second argument. In this table you will find all setting options:

Name Type Default Description
linebreak string "\r\n" New line characters
indentation string "\t" Characters for indentation
preserveSpaceAttribute string "xml:space" Attribute name for preserve space
preserveSpaceFn Function Function to check if preserve space is active

License

MIT

Package Sidebar

Install

npm i xformatting

Weekly Downloads

125

Version

2.2.0

License

MIT

Unpacked Size

86.5 kB

Total Files

42

Last publish

Collaborators

  • xpublisher