Repository files navigation

hast utility to transform to aparse5AST.

• What is this?
• When should I use this?
• Install
• Use
• API
  • toParse5(tree[, options])
  • Options
  • Space
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a utility that can turn a hast syntax tree into aparse5 AST.Why not use a Parse5 adapter, you might ask?Well, because it’s more code weight to use adapters, and more fragile.

This package is useful when working withparse5, and for some reason want togenerate its AST again.The inverse utility,hast-util-from-parse5, is morelikely what you want.

This package isESM only.In Node.js (version 16+), install withnpm:

npm install hast-util-to-parse5

In Deno withesm.sh:

import{toParse5}from'https://esm.sh/hast-util-to-parse5@8'

In browsers withesm.sh:

<scripttype="module">import{toParse5}from'https://esm.sh/hast-util-to-parse5@8?bundle'</script>

import{toParse5}from'hast-util-to-parse5'consttree=toParse5({type:'element',tagName:'h1',properties:{},children:[{type:'text',value:'World!'}]})console.log(tree)

Yields:

{nodeName:'h1',tagName:'h1',attrs:[],namespaceURI:'http://www.w3.org/1999/xhtml',childNodes:[{nodeName:'#text',value:'World!',parentNode:[Circular]}]}

This package exports the identifiertoParse5.There is no default export.

Transform a hast tree to aparse5 AST.

• tree (HastNode)— tree to transform
• options (Options, optional)— configuration

parse5 node (Parse5Node).

Configuration (TypeScript type).

• space (Space, optional)— which space the document is in

Namespace (TypeScript type).

typeSpace='html'|'svg'

This package is fully typed withTypeScript.It exports the additional typesOptions andSpace.

Projects maintained by the unified collective are compatible with maintainedversions of Node.js.

When we cut a new major release, we drop support for unmaintained versions ofNode.This means we try to keep the current release line,hast-util-to-parse5@^8,compatible with Node.js 16.

Use ofhast-util-to-parse5 can open you up to across-site scripting (XSS) attack if the hast tree is unsafe.

• hast-util-from-parse5— transform from Parse5’s AST to hast
• hast-util-to-nlcst— transform hast to nlcst
• hast-util-to-mdast— transform hast to mdast
• hast-util-to-xast— transform hast to xast
• mdast-util-to-hast— transform mdast to hast
• mdast-util-to-nlcst— transform mdast to nlcst

Seecontributing.md insyntax-tree/.github forways to get started.Seesupport.md for ways to get help.

This project has acode of conduct.By interacting with this repository, organization, or community you agree toabide by its terms.

MIT ©Titus Wormer