Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/syntax-tree/hast-util-has-property
utility to check if a node has a property
https://github.com/syntax-tree/hast-util-has-property
attribute has hast hast-util html property unist
Last synced: about 2 months ago
JSON representation
utility to check if a node has a property
- Host: GitHub
- URL: https://github.com/syntax-tree/hast-util-has-property
- Owner: syntax-tree
- License: mit
- Created: 2016-04-15T15:42:18.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-08-01T08:58:12.000Z (over 1 year ago)
- Last Synced: 2024-09-19T03:36:55.841Z (4 months ago)
- Topics: attribute, has, hast, hast-util, html, property, unist
- Language: JavaScript
- Homepage: https://unifiedjs.com
- Size: 93.8 KB
- Stars: 1
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-syntax-tree - hast-util-has-property - Check if a node has a property. (hast utilities)
README
# hast-util-has-property
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[hast][] utility to check if an element has a certain property.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`hasProperty(node, field)`](#haspropertynode-field)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## 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][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install hast-util-has-property
```
In Deno with [`esm.sh`][esmsh]:
```js
import {hasProperty} from 'https://esm.sh/hast-util-has-property@3'
```
In browsers with [`esm.sh`][esmsh]:
```html
import {hasProperty} from 'https://esm.sh/hast-util-has-property@3?bundle'
```
## Use
```js
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`][api-has-property].
There is no default export.
### `hasProperty(node, field)`
Check if `node`is an element and has a `name` property.
###### Parameters
* `node` (`Node`) — node to check (typically [`Element`][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)][xss] attacks.
## Related
* [`hast-util-is-element`](https://github.com/syntax-tree/hast-util-is-element)
— check if a node is a (certain) element
* [`hast-util-is-body-ok-link`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-body-ok-link)
— check if a node is “Body OK” link element
* [`hast-util-is-conditional-comment`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-conditional-comment)
— check if a node is a conditional comment
* [`hast-util-is-css-link`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-css-link)
— check if a node is a CSS link element
* [`hast-util-is-css-style`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-css-style)
— check if a node is a CSS style element
* [`hast-util-embedded`](https://github.com/syntax-tree/hast-util-embedded)
— check if a node is an embedded element
* [`hast-util-heading`](https://github.com/syntax-tree/hast-util-heading)
— check if a node is a heading element
* [`hast-util-interactive`](https://github.com/syntax-tree/hast-util-interactive)
— check if a node is interactive
* [`hast-util-is-javascript`](https://github.com/rehypejs/rehype-minify/tree/main/packages/hast-util-is-javascript)
— check if a node is a JavaScript script element
* [`hast-util-labelable`](https://github.com/syntax-tree/hast-util-labelable)
— check whether a node is labelable
* [`hast-util-phrasing`](https://github.com/syntax-tree/hast-util-phrasing)
— check if a node is phrasing content
* [`hast-util-script-supporting`](https://github.com/syntax-tree/hast-util-script-supporting)
— check if a node is a script-supporting element
* [`hast-util-sectioning`](https://github.com/syntax-tree/hast-util-sectioning)
— check if a node is a sectioning element
* [`hast-util-transparent`](https://github.com/syntax-tree/hast-util-transparent)
— check if a node is a transparent element
* [`hast-util-whitespace`](https://github.com/syntax-tree/hast-util-whitespace)
— check if a node is inter-element whitespace
## Contribute
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
ways to get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/syntax-tree/hast-util-has-property/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/hast-util-has-property/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-has-property.svg
[coverage]: https://codecov.io/github/syntax-tree/hast-util-has-property
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-has-property.svg
[downloads]: https://www.npmjs.com/package/hast-util-has-property
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-has-property
[size]: https://bundlejs.com/?q=hast-util-has-property
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/syntax-tree/unist/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[license]: license
[author]: https://wooorm.com
[health]: https://github.com/syntax-tree/.github
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[hast]: https://github.com/syntax-tree/hast
[element]: https://github.com/syntax-tree/hast#element
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[api-has-property]: #haspropertynode-field