unified

Project: syntax-tree/xast-util-from-xml

Package: xast-util-from-xml@2.0.1

  1. Dependents: 0
  2. xast utility to parse from XML
  1. util 147
  2. utility 143
  3. unist 131
  4. tree 44
  5. ast 37
  6. syntax 28
  7. parse 24
  8. markup 19
  9. language 12
  10. xml 10
  11. xast 8
  12. xast-util 7
  13. extensible 2

xast-util-from-xml

Build Coverage Downloads Size Sponsors Backers Chat

xast utility to parse from XML.

Contents

What is this?

This package is a utility that takes XML input and turns it into a xast syntax tree. It uses sax, which turns XML into events, while it turns those events into nodes.

When should I use this?

If you want to handle syntax trees, use this. Use sax itself instead when you want to do other things.

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 12.20+, 14.14+, 16.0+, or 18.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@2'

In browsers with esm.sh:

<script type="module">
  import {fromXml} from 'https://esm.sh/xast-util-from-xml@2?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.log(tree)

…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'}
      ]
    },
    {type: 'text', value: '\n'}
  ]
}

API

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

fromXml(value)

Turn XML into a syntax tree.

Parameters
value

Value to parse (string or Buffer in UTF-8).

Returns

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 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.

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