National Poo Museum

    xast-util-to-xml
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.1 • Public • Published

    xast-util-to-xml

    Build Coverage Downloads Size Sponsors Backers Chat

    xast utility to serialize as XML.

    Contents

    What is this?

    This package is a utility that turns a xast tree into a string of XML.

    When should I use this?

    You can use this utility when you want to get the serialized XML that is represented by the syntax tree, either because you’re done with the syntax tree, or because you’re integrating with another tool that does not support syntax trees.

    This utility has options to configure how the XML is serialized. These options help when building tools that make output pretty (such as formatters) or ugly (such as minifiers).

    The utility xast-util-from-xml does the inverse of this utility. It turns XML into xast.

    The utility hast-util-to-html does the same as this utility but for HTML: it turns hast into HTML.

    Install

    This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:

    npm install xast-util-to-xml

    In Deno with esm.sh:

    import {toXml} from 'https://esm.sh/xast-util-to-xml@3'

    In browsers with esm.sh:

    <script type="module">
      import {toXml} from 'https://esm.sh/xast-util-to-xml@3?bundle'
    </script>

    Use

    import {u} from 'unist-builder'
    import {x} from 'xastscript'
    import {toXml} from 'xast-util-to-xml'
    
    const tree = u('root', [
      u('instruction', {name: 'xml'}, 'version="1.0" encoding="utf-8"'),
      u('text', '\n'),
      x('ncx', {xmlns: 'http://www.daisy.org/z3986/2005/ncx/', version: '2005-1'}, [
        u('text', '\n  '),
        x('head', [
          u('text', '\n    '),
          x('meta', {name: 'dtb:uid', content: 'urn:isbn:9781234567891'}),
          u('text', '\n  ')
        ]),
        u('text', '\n  '),
        x('docTitle', [x('text', 'A Christmas Carol')]),
        u('text', '\n  '),
        x('docAuthor', [x('text', 'Charles Dickens')]),
        u('text', '\n')
      ])
    ])
    
    console.log(toXml(tree))

    Yields:

    <?xml version="1.0" encoding="utf-8"?>
    <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
      <head>
        <meta name="dtb:uid" content="urn:isbn:9781234567891"></meta>
      </head>
      <docTitle><text>A Christmas Carol</text></docTitle>
      <docAuthor><text>Charles Dickens</text></docAuthor>
    </ncx>

    API

    This package exports the identifier toXml. There is no default export.

    toXml(tree[, options])

    Serialize a xast tree to XML.

    Parameters
    • tree (Node or Array<Node>) — xast node(s) to serialize
    • options (Options, optional) — configuration
    Returns

    Serialized XML (string).

    Options

    Configuration (TypeScript type).

    Fields
    allowDangerousXml

    Allow raw nodes and insert them as raw XML (boolean, default: false).

    When false, Raw nodes are encoded.

    ⚠️ Danger: only set this if you completely trust the content.

    closeEmptyElements

    Close elements without any content with slash (/) on the opening tag instead of an end tag: <circle /> instead of <circle></circle> (boolean, default: false).

    See tightClose to control whether a space is used before the slash.

    quote

    Preferred quote to use (Quote, default: '"').

    quoteSmart

    Use the other quote if that results in less bytes (boolean, default: false).

    tightClose

    Do not use an extra space when closing self-closing elements: <circle/> instead of <circle /> (boolean, default: false).

    👉 Note: only used if closeEmptyElements: true.

    Quote

    XML quotes for attribute values (TypeScript type).

    Type
    type Quote = '"' | "'"

    Types

    This package is fully typed with TypeScript. It exports the additional types Options and Quote.

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    Security

    XML can be a dangerous language: don’t trust user-provided data.

    Related

    Contribute

    See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

    This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i xast-util-to-xml

    DownloadsWeekly Downloads

    2,114

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    26.6 kB

    Total Files

    31

    Last publish

    Collaborators

    • wooorm
    • kmck