Awesome
xast-util-from-xml
xast utility to parse from XML.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- 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 16+), install with npm:
npm install xast-util-from-xml
In Deno with esm.sh
:
import {fromXml} from 'https://esm.sh/xast-util-from-xml@4'
In browsers with esm.sh
:
<script type="module">
import {fromXml} from 'https://esm.sh/xast-util-from-xml@4?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: undefined})
…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
(Uint8Array
in UTF-8 orstring
). — serialized XML
Returns
xast root (Root
).
Throws
When the XML cannot be parsed with @rgrove/parse-xml
, a
VFileMessage
is thrown.
This can for example happen when passing archaic or unsafe XML (such as entities), or just otherwise invalid XML such as missnested tags.
Types
This package is fully typed with TypeScript. It exports no additional types.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, xast-util-from-xml@^4
,
compatible with Node.js 16.
Security
XML can be a dangerous language: don’t trust user-provided data.
Related
xast-util-to-xml
— serialize xast to XMLhast-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.