Repository files navigation

hast utility to check if a node isembedded content.

• What is this?
• When should I use this?
• Install
• Use
• API
  • embedded(value)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a small utility that checks if a node is embedded contentaccording to HTML.

This utility is super niche, if you’re here you probably know what you’relooking for!

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

npm install hast-util-embedded

In Deno withesm.sh:

import{embedded}from'https://esm.sh/hast-util-embedded@3'

In browsers withesm.sh:

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

import{embedded}from'hast-util-embedded'// Given a non-embedded value:embedded({type:'element',tagName:'a',properties:{href:'#alpha',title:'Bravo'},children:[{type:'text',value:'Charlie'}]})// => false// Given a embedded element:embedded({type:'element',tagName:'audio',properties:{src:'delta.ogg'},children:[]})// => true

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

Check ifnode is anembedded content.

• value (unknown)— thing to check (typicallyNode)

Whethervalue is an element considered embedded content (boolean).

The elementsaudio,canvas,embed,iframe,img,math,object,picture,svg, andvideo are embedded content.

This package is fully typed withTypeScript.It exports no additional types.

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-embedded@^3,compatible with Node.js 16.

hast-util-embedded does not change the syntax tree so there are no openingsforcross-site scripting (XSS) attacks.

• hast-util-is-element— check if a node is a (certain) element
• hast-util-has-property— check if a node has a property
• hast-util-is-body-ok-link— check if a node is “Body OK” link element
• hast-util-is-conditional-comment— check if a node is a conditional comment
• hast-util-is-css-link— check if a node is a CSS link element
• hast-util-is-css-style— check if a node is a CSS style element
• hast-util-heading— check if a node is a heading element
• hast-util-interactive— check if a node is interactive
• hast-util-is-javascript— check if a node is a JavaScript script element
• hast-util-labelable— check whether a node is labelable
• hast-util-phrasing— check if a node is phrasing content
• hast-util-script-supporting— check if a node is a script-supporting element
• hast-util-sectioning— check if a node is a sectioning element
• hast-util-transparent— check if a node is a transparent element
• hast-util-whitespace— check if a node is inter-element whitespace

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