XML Utilities

The XML namespace object provides utility functions for working with the internal xml-js element tree. Import it from xml-model:

import XML from "xml-model/xml";
// or from the main entry
import { XML } from "xml-model";

XML.parse

Parses an XML string into an XMLRoot document tree.

const root = XML.parse("<book><title>Dune</title></book>");
// { elements: [{ type: "element", name: "book", elements: [...] }] }

XML.stringify

Serialises an XMLRoot or XMLElement back into an XML string.

const xmlString = XML.stringify(root);
// "<book><title>Dune</title></book>"

XML.getContent

Extracts the text content from an element that contains a single text node.

const el = { type: "element", name: "title", elements: [{ type: "text", text: "Dune" }] };
XML.getContent(el); // "Dune"

// Returns "" for elements with no children
XML.getContent({ type: "element", name: "empty" }); // ""

Throws a TypeError when the element has multiple children or a non-text child.

XML.fromContent

Creates an element structure wrapping text content.

// Fragment (no tag name)
XML.fromContent("hello");
// { elements: [{ type: "text", text: "hello" }] }

// Full element
XML.fromContent("hello", "greeting");
// { type: "element", name: "greeting", elements: [{ type: "text", text: "hello" }] }

// With attributes
XML.fromContent("hello", "greeting", { lang: "en" });
// { type: "element", name: "greeting", attributes: { lang: "en" }, elements: [...] }

XML.addElement

Appends a child element to a parent, initialising the elements array if needed.

const parent = { type: "element", name: "book" };
XML.addElement(parent, { type: "element", name: "chapter" });
// parent.elements === [{ type: "element", name: "chapter" }]

XML.setAttribute

Sets an attribute on an element, initialising the attributes map if needed.

const el = { type: "element", name: "book" };
XML.setAttribute(el, "lang", "en");
// el.attributes === { lang: "en" }

XML.deleteAttribute

Removes an attribute from an element. Does nothing when the element has no attributes.

XML.deleteAttribute(el, "lang");
// el.attributes === {}