Repository files navigation

hast utility to check if a node isinter-element whitespace.

• What is this?
• When should I use this?
• Install
• Use
• API
  • whitespace(thing)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a small utility that checks if a node is whitespace according toHTML.

This utility is super niche, if you’re here you probably know what you’relooking for!

This package isESM only.In Node.js (version 16+), install withnpm:

npm install hast-util-whitespace

In Deno withesm.sh:

import{whitespace}from'https://esm.sh/hast-util-whitespace@3'

In browsers withesm.sh:

<scripttype="module">import{whitespace}from'https://esm.sh/hast-util-whitespace@3?bundle'</script>

import{whitespace}from'hast-util-whitespace'whitespace({type:'element',tagName:'div',properties:{},children:[]})// => falsewhitespace({type:'text',value:'\t  \n'})// => truewhitespace({type:'text',value:'  text\f'})// => false

This package exports the identifierwhitespace.There is no default export.

Check if the given value isinter-element whitespace.

• thing (Node orstring, optional)— thing to check

Whether thevalue is inter-element whitespace (boolean): consisting of zeroor more of space, tab (\t), line feed (\n), carriage return (\r), or formfeed (\f).If a node is passed it must be aText node, whosevalue field ischecked.

This package is fully typed withTypeScript.It exports no additional types.

Projects maintained by the unified collective are compatible with maintainedversions of Node.js.

When we cut a new major release, we drop support for unmaintained versions ofNode.This means we try to keep the current release line,hast-util-whitespace@^3,compatible with Node.js 16.

hast-util-whitespace does not change the syntax tree so there are no openingsforcross-site scripting (XSS) attacks.

• hast-util-is-element— check if a node is a (certain) element
• hast-util-has-property— check if a node has a property
• hast-util-transparent— check if a node is a transparent element
• hast-util-heading— check if a node is a heading element
• hast-util-labelable— check whether a node is labelable
• hast-util-phrasing— check if a node is phrasing content
• hast-util-embedded— check if a node is an embedded element
• hast-util-sectioning— check if a node is a sectioning element
• hast-util-interactive— check if a node is interactive
• hast-util-script-supporting— check if a node is a script-supporting element
• hast-util-is-body-ok-link— check if a node is “Body OK” link element
• hast-util-is-conditional-comment— check if a node is a conditional comment
• hast-util-is-css-link— check if a node is a CSS link element
• hast-util-is-css-style— check if a node is a CSS style element
• hast-util-is-javascript— check if a node is a JavaScript script element

Seecontributing.md insyntax-tree/.github forways to get started.Seesupport.md for ways to get help.

This project has acode of conduct.By interacting with this repository, organization, or community you agree toabide by its terms.

MIT ©Titus Wormer