unified

Project: syntax-tree/hast-util-embedded

Package: hast-util-embedded@2.0.0

  1. Dependencies: 1·Dependents: 7
  2. hast utility to check if a node is an embedded element
  1. util 128
  2. utility 124
  3. unist 119
  4. html 110
  5. hast 61
  6. hast-util 40
  7. category 7

hast-util-embedded

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to check if an element is embedded.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install hast-util-embedded

Use

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

API

This package exports the following identifiers: embedded. There is no default export.

embedded(node)

Check if node is an embedded element.

Security

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

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.

License

MIT © Titus Wormer