xast-util-from-xml

xast utility to parse from XML.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • fromXml(value)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a utility that takes serialized XML as input and turns it into a xast syntax tree. It uses @rgrove/parse-xml, which is a good and fast XML parser, and turns its results into xast.

When should I use this?

If you want to use xast syntax trees, use this.

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

Install

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

npm install xast-util-from-xml

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

Say our document example.xml contains:

<album id="123">
  <name>Born in the U.S.A.</name>
  <artist>Bruce Springsteen</artist>
  <releasedate>1984-04-06</releasedate>
</album>

…and our module example.js looks as follows:

import fs from 'node:fs/promises'
import {fromXml} from 'xast-util-from-xml'

const tree = fromXml(await fs.readFile('example.xml'))

console.dir(tree, {depth: null})

…now running node example.js yields (positional info removed for brevity):

{
  type: 'root',
  children: [
    {
      type: 'element',
      name: 'album',
      attributes: {id: '123'},
      children: [
        {type: 'text', value: '\n  '},
        {
          type: 'element',
          name: 'name',
          attributes: {},
          children: [{type: 'text', value: 'Born in the U.S.A.'}]
        },
        {type: 'text', value: '\n  '},
        {
          type: 'element',
          name: 'artist',
          attributes: {},
          children: [{type: 'text', value: 'Bruce Springsteen'}]
        },
        {type: 'text', value: '\n  '},
        {
          type: 'element',
          name: 'releasedate',
          attributes: {},
          children: [{type: 'text', value: '1984-04-06'}]
        },
        {type: 'text', value: '\n'}
      ]
    }
  ]
}

API

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

fromXml(value)

Parse a string of XML to a xast tree.

Parameters

• value (string or Buffer in UTF-8). — serialized XML

Returns

xast root (Root).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.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

• xast-util-to-xml — serialize xast to XML
• hast-util-to-xast — transform hast (html, svg) to xast (xml)
• xastscript — create xast trees

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