hast-util-is-conditional-comment
hast
utility to check if a node is a conditional comment.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is a utility to check whether a hast node is a “conditional” comment. Conditional comments are a legacy feature that was specific to Internet Explorer. They were no longer used in IE 10.
When should I use this?
You can use this package when you’re building tools that handle old and non-standard HTML, but generally it’s recommended to remove conditional comments.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install hast-util-is-conditional-comment
In Deno with esm.sh
:
import {isConditionalComment} from 'https://esm.sh/hast-util-is-conditional-comment@2'
In browsers with esm.sh
:
<script type="module">
import {isConditionalComment} from 'https://esm.sh/hast-util-is-conditional-comment@2?bundle'
</script>
Use
import {u} from 'unist-builder'
import {isConditionalComment} from 'hast-util-is-conditional-comment'
isConditionalComment(u('comment', '[if IE]>...<![endif]')) //=> true
isConditionalComment(u('comment', '<![endif]')) //=> true
isConditionalComment(u('comment', 'foo')) //=> false
API
This package exports the following identifiers: isConditionalComment
. There is no default export.
isConditionalComment(node)
Check if a node is a conditional comment.
Parameters
node
(Node
) — hast node
Returns
Whether a node is a conditional comment (boolean
).
Syntax
HTML is handled according to WHATWG HTML (the living standard), which is also followed by browsers such as Chrome and Firefox.
Syntax tree
The syntax tree format used is hast
.
Types
This package is fully typed with TypeScript.
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.