Awesome
hast-util-script-supporting
hast utility to check if a node is a script-supporting element.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package is a small utility that checks if a node is script-supporting according to HTML.
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-script-supporting
In Deno with esm.sh
:
import {scriptSupporting} from 'https://esm.sh/hast-util-script-supporting@3'
In browsers with esm.sh
:
<script type="module">
import {scriptSupporting} from 'https://esm.sh/hast-util-script-supporting@3?bundle'
</script>
Use
import {scriptSupporting} from 'hast-util-script-supporting'
scriptSupporting({
type: 'element',
tagName: 'a',
properties: {href: '#alpha', title: 'Bravo'},
children: [{type: 'text', value: 'Charlie'}]
}) // => false
scriptSupporting({
type: 'element',
tagName: 'template',
properties: {},
children: [],
content: {type: 'root', children: [{type: 'text', value: 'Delta'}]}
}) // => true
API
This package exports the identifier
scriptSupporting
.
There is no default export.
scriptSupporting(value)
Check if the given value is a script-supporting element.
Parameters
value
(unknown
) — thing to check (typicallyNode
)
Returns
Whether value
is a script-supporting element (boolean
).
The elements script
and template
are script-supporting.
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-script-supporting@^3
, compatible with Node.js 16.
Security
hast-util-script-supporting
does not change the syntax tree so there are no
openings for cross-site scripting (XSS) attacks.
Related
hast-util-is-element
— check if a node is a (certain) elementhast-util-has-property
— check if a node has a propertyhast-util-is-body-ok-link
— check if a node is “Body OK” link elementhast-util-is-conditional-comment
— check if a node is a conditional commenthast-util-is-css-link
— check if a node is a CSS link elementhast-util-is-css-style
— check if a node is a CSS style elementhast-util-embedded
— check if a node is an embedded elementhast-util-heading
— check if a node is a heading elementhast-util-interactive
— check if a node is interactivehast-util-is-javascript
— check if a node is a JavaScript script elementhast-util-labelable
— check whether a node is labelablehast-util-phrasing
— check if a node is phrasing contenthast-util-sectioning
— check if a node is a sectioning elementhast-util-transparent
— check if a node is a transparent elementhast-util-whitespace
— check if a node is inter-element whitespace
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.