hast-util-whitespace
hast utility to check if a node is inter-element whitespace.
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 whitespace 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-whitespace
In Deno with esm.sh
:
import {whitespace} from 'https://esm.sh/hast-util-whitespace@3'
In browsers with esm.sh
:
<script type="module">
import {whitespace} from 'https://esm.sh/hast-util-whitespace@3?bundle'
</script>
Use
import {whitespace} from 'hast-util-whitespace'
whitespace({
type: 'element',
tagName: 'div',
properties: {},
children: []
}) // => false
whitespace({
type: 'text',
value: '\t \n'
}) // => true
whitespace({
type: 'text',
value: ' text\f'
}) // => false
API
This package exports the identifier whitespace
.
There is no default export.
whitespace(thing)
Check if the given value is inter-element whitespace.
Parameters
-
thing
(Node
orstring
, optional) β thing to check
Returns
Whether the value
is inter-element whitespace (boolean
): consisting of zero
or more of space, tab (\t
), line feed (\n
), carriage return (\r
), or form
feed (\f
).
If a node is passed it must be a Text
node, whose value
field is
checked.
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-whitespace@^3
,
compatible with Node.js 16.
Security
hast-util-whitespace
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) 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
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