Serialization

#Basic Serialization

import { parse, stringify } from "@office-open/xml";

const root = parse("<w:p><w:r><w:t>Hello</w:t></w:r></w:p>");
const xml = stringify(root);
// '<w:p><w:r><w:t>Hello</w:t></w:r></w:p>'

#stringify(root, options?)

const xml = stringify(root, {
  spaces: 2,
  ignoreDeclaration: true,
});

#Options

Option	Type	Default	Description
`spaces`	`number \| string`	`0`	Indentation (number of spaces or string like `"\t"`)
`fullTagEmptyElement`	`boolean`	`false`	Use `<tag></tag>` instead of `<tag/>` for empty elements
`indentText`	`boolean`	`false`	Indent text nodes by depth
`indentCdata`	`boolean`	`false`	Indent CDATA nodes by depth
`ignoreDeclaration`	`boolean`	`false`	Omit XML declaration
`ignoreComment`	`boolean`	`false`	Omit comments
`ignoreCdata`	`boolean`	`false`	Omit CDATA sections
`ignoreDoctype`	`boolean`	`false`	Omit DOCTYPE
`ignoreText`	`boolean`	`false`	Omit text nodes
`attributeValueFn`	`function`	—	Custom attribute value processor

#Formatted Output

const xml = stringify(root, { spaces: 2 });
// <w:p>
//   <w:r>
//     <w:t>Hello</w:t>
//   </w:r>
// </w:p>

#Round-trip Example

Parse an XML string, modify the tree, and serialize back:

import { parse, stringify, findChild, children } from "@office-open/xml";

const root = parse("<w:p><w:r><w:t>Hello</w:t></w:r></w:p>");
const runs = children(root, "w:r");
// ... modify the tree ...
const output = stringify(root);