hast-util-is-body-ok-link
hast
utility to check if a link
element is “body OK”.
Contents
What is this?
This package is a utility that, when given a hast node, checks whether it
is a “body OK” link.
When should I use this?
You can use this package to check whether links can exist inside <body>
(outside of <head>
).
Install
This package is ESM only.
In Node.js (version 16+), install with npm:
npm install hast-util-is-body-ok-link
In Deno with esm.sh
:
import {isBodyOkLink} from 'https://esm.sh/hast-util-is-body-ok-link@3'
In browsers with esm.sh
:
<script type="module">
import {isBodyOkLink} from 'https://esm.sh/hast-util-is-body-ok-link@3?bundle'
</script>
Use
import {h} from 'hastscript'
import {isBodyOkLink} from 'hast-util-is-body-ok-link'
isBodyOkLink(h('link', {itemProp: 'foo'}))
isBodyOkLink(h('link', {rel: ['stylesheet'], href: 'index.css'}))
isBodyOkLink(h('link', {rel: ['author'], href: 'index.css'}))
API
This package exports the identifier
isBodyOkLink
.
There is no default export.
isBodyOkLink(node)
Check whether a node is a “body OK” link.
The following nodes are “body OK” links:
link
elements with an itemProp
link
elements with a rel
list where one or more entries are
pingback
, prefetch
, or stylesheet
Parameters
node
(Node
) — node to check.
Returns
Whether a node is a “body OK” link (boolean
).
Syntax
HTML is parsed according to WHATWG HTML (the living standard), which is also
followed by all browsers.
Syntax tree
The syntax tree used is hast.
Types
This package is fully typed with TypeScript.
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-is-body-ok-link@^3
,
compatible with Node.js 16.
Security
As rehype works on HTML and improper use of HTML can open you up to a
cross-site scripting (XSS) attack, use of rehype can also be unsafe.
Use rehype-sanitize
to make the tree safe.
Contribute
See contributing.md
in rehypejs/.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