hast-util-has-property
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

hast-util-has-property

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to check if an element has a certain property.

Contents

What is this?

This package is a small utility that checks if a node is an element that has a given property.

When should I use this?

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

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install hast-util-has-property

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {hasProperty} from 'hast-util-has-property'

hasProperty({type: 'text', value: 'alpha'}, 'bravo') // => false

hasProperty(
  {
    type: 'element',
    tagName: 'div',
    properties: {id: 'bravo'},
    children: []
  },
  'className'
) // => false

hasProperty(
  {
    type: 'element',
    tagName: 'div',
    properties: {id: 'charlie'},
    children: []
  },
  'id'
) // => true

API

This package exports the identifier hasProperty. There is no default export.

hasProperty(node, field)

Check if nodeis an element and has a name property.

Parameters
  • node (Node) — node to check (typically Element)
  • name (string) - property name to check
Returns

Whether node is an element that has a name property (boolean).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

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

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

Security

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

Related

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

Package Sidebar

Install

npm i hast-util-has-property

Weekly Downloads

520,904

Version

3.0.0

License

MIT

Unpacked Size

11.8 kB

Total Files

7

Last publish

Collaborators

  • wooorm
  • kmck