8000 GitHub - syntax-tree/hast-util-script-supporting at 2.0.1
[go: up one dir, main page]

Skip to content

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 14.14+ and 16.0+), install with npm:

npm install hast-util-script-supporting

In Deno with esm.sh:

import {scriptSupporting} from 'https://esm.sh/hast-util-script-supporting@2'

In browsers with esm.sh:

<script type="module">
  import {scriptSupporting} from 'https://esm.sh/hast-util-script-supporting@2?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',
  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 all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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

About

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

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Contributors 2

  •  
  •  
0