unified

Project: syntax-tree/hast-util-is-element

Package: hast-util-is-element@1.1.0

  1. Dependencies: 0·Dependents: 56
  2. hast utility to check if a node is a (certain) element
  1. util 119
  2. utility 115
  3. unist 111
  4. html 110
  5. hast 61
  6. hast-util 40
  7. element 5
  8. is 3

hast-util-is-element

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to check if a node is a (certain) element.

Install

npm:

npm install hast-util-is-element

Use

var is = require('hast-util-is-element')

is({type: 'text', value: 'foo'}) // => false

is({type: 'element', tagName: 'a'}, 'a') // => true

is({type: 'element', tagName: 'a'}, ['a', 'area']) // => true

API

isElement(node[, test[, index, parent[, context]]])

Check if the given value is a (certain) element.

Returns

boolean — Whether test passed and node is an Element.

Throws

Error — When an incorrect test, index, or parent is given. A node that is not a node, or not an element, does not throw.

function test(element[, index, parent])

Parameters
Context

* — The to is given context.

Returns

boolean? — Whether element matches.

isElement.convert(test)

Create a test function from test, that can later be called with a node, index, and parent. Useful if you’re going to test many nodes, for example when creating a utility where something else passes a compatible test.

The created function is slightly faster because it expects valid input only. Therefore, passing invalid input, yields unexpected results.

Can also be accessed with require('hast-util-is-element/convert').

Security

hast-util-is-element 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