Urara-Blog/node_modules/.pnpm-store/v3/files/fd/676c8a865e615b87ec51a3c8c80d85cbbfdb31494505b8f3bb183a2ba5659a65f40590e33027b46007a9d999a142c76e583b108bbdff5c6da0e218368b46b1
2022-08-14 01:14:53 +08:00

173 lines
5.6 KiB
Text

# 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**][hast] utility to check if an [*element*][element] has a
[*property*][property].
## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
[npm][]:
```sh
npm install hast-util-has-property
```
## 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 following identifiers: `hasProperty`.
There is no default export.
### `hasProperty(node, name)`
Check if `node` is an [*element*][element] that has a `name`
[*property name*][property].
###### Parameters
* `node` ([`Node`][node], optional) — [*Node*][node] to check
* `name` (`string`) - [*Property name*][property]
###### Returns
`boolean` — Whether `node` is an [*element*][element] that has a `name`
[*property name*][property].
## 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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/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` in `syntax-tree/.github`][contributing] 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]
<!-- Definition -->
[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/bundlephobia/minzip/hast-util-has-property.svg
[size]: https://bundlephobia.com/result?p=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
[license]: license
[author]: https://wooorm.com
[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
[hast]: https://github.com/syntax-tree/hast
[node]: https://github.com/syntax-tree/hast#nodes
[element]: https://github.com/syntax-tree/hast#element
[property]: https://github.com/syntax-tree/hast#property-names
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting