hast-util-to-xast
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechathast (HTML) utility to transform to xast (XML).
Contents
* [`toXast(tree[, options])`](#toxasttree-options)
* [`Options`](#options)
* [`Space`](#space-1)
What is this?
This package is a utility that takes a hast (HTML) syntax tree as input and turns it into a xast (XML) syntax tree. This package also supports embedded MDX nodes.When should I use this?
This project is useful when you want to deal with ASTs, and for some reason, have to deal with XML. One example of this is for EPUB (digital books).There is no inverse of this utility, because not all XML is HTML.
A similar package,
hast-util-to-estree
hast-util-to-estree, can turn
hast into estree (JavaScript) as JSX, which has some similarities to XML.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install hast-util-to-xast
In Deno with
esm.sh
esmsh:import {toXast} from "https://esm.sh/hast-util-to-xast@3"
In browsers with
esm.sh
esmsh:<script type="module">
import {toXast} from "https://esm.sh/hast-util-to-xast@3?bundle"
</script>
Use
Say our documentexample.html
contains:<!doctypehtml>
<title>Hello, World!</title>
<h1>π, π</h1>
β¦and our module
example.js
looks as follows:import fs from 'node:fs/promises'
import {fromHtml} from 'hast-util-from-html'
import {toXast} from 'hast-util-to-xast'
import {toXml} from 'xast-util-to-xml'
// Get the HTML syntax tree:
const hast = fromHtml(await fs.readFile('example.html'))
// Turn hast to xast:
const xast = toXast(hast)
// Serialize xast:
console.log(toXml(xast))
β¦now running
node example.js
yields:<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>Hello, World!</title>
</head><body><h1>π, π</h1>
</body></html>
API
This package exports the identifiertoXast
api-to-xast.
There is no default export.toXast(tree[, options])
Turn a hast tree into a xast tree.Parameters
β hast tree to transform
options
(Options
api-options, optional)
β configuration
Returns
xast tree (XastNode
xast-node).Options
Configuration (TypeScript type).Fields
space
Which space the document is in (Space
api-space, default: 'html'
).When an
<svg>
element is found in the HTML space, this package already
automatically switches to and from the SVG space when entering and exiting it.You can also switch explicitly with
xmlns
properties in hast, but note that
only HTML and SVG are supported.Space
Namespace (TypeScript type).Type
type Space = 'html' | 'svg'
Types
This package is fully typed with TypeScript. It exports the additional typesOptions
api-options and
Space
api-space.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,
hast-util-to-xast@^3
,
compatible with Node.js 16.Security
Both HTML and XML can be dangerous languages: donβt trust user-provided data. Usehast-util-santize
hast-util-sanitize to make the hast tree safe before
using this utility.Related
β create **[hast][]** (HTML or SVG) trees
β create **[xast][]** (XML) trees
β serialize as XML
Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.