Project: syntax-tree/hast-util-raw

Package: hast-util-raw@6.1.0

  1. Dependencies: 11·Dependents: 19
  2. hast utility to reparse a tree
  1. util 130
  2. utility 126
  3. unist 120
  4. html 109
  5. hast 62
  6. hast-util 41
  7. parse 22
  8. raw 3


Build Coverage Downloads Size Sponsors Backers Chat

hast utility to parse the tree again, now supporting embedded raw nodes.

One of the reasons to do this is for “malformed” syntax trees: for example, say there’s an h1 element in a p element, this utility will make them siblings.

Another reason to do this is if raw HTML/XML is embedded in a syntax tree, which can occur when coming from Markdown using mdast-util-to-hast.

If you’re working with remark and/or remark-rehype, use rehype-raw instead.



npm install hast-util-raw


var h = require('hastscript')
var raw = require('hast-util-raw')

var tree = h('div', [h('h1', ['Foo ', h('h2', 'Bar'), ' Baz'])])

var clean = raw(tree)



{ type: 'element',
  tagName: 'div',
  properties: {},
   [ { type: 'element',
       tagName: 'h1',
       properties: {},
       children: [Object] },
     { type: 'element',
       tagName: 'h2',
       properties: {},
       children: [Object] },
     { type: 'text', value: ' Baz' } ] }


raw(tree[, file][, options])

Given a hast tree and an optional vfile (for positional info), return a new parsed-again hast tree.


List of custom hast node types to pass through (keep) in hast (Array.<string>, default: []). If the passed through nodes have children, those children are expected to be hast and will be handled.


Use of hast-util-raw can open you up to a cross-site scripting (XSS) attack as raw nodes are unsafe. The following example shows how a raw node is used to inject a script that runs when loaded in a browser.

raw(u('root', [u('raw', '<script>alert(1)</script>')]))



Do not use this utility in combination with user input or use hast-util-santize.


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.


MIT © Titus Wormer