Skip to content

utility to check if a node is a script-supporting element

License

Notifications You must be signed in to change notification settings

syntax-tree/hast-util-script-supporting

Repository files navigation

hast-util-script-supporting

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to check if a node is a script-supporting element.

Contents

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 (typically Node)
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

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