hast-util-whitespace
![Chat](https://img.shields.io/badge/chat-discussions-success.svg)
hast utility to check if a node is inter-element whitespace.
Contents
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 14.14+ and 16.0+), install with npm:
npm install hast-util-whitespace
In Deno with esm.sh
:
import {whitespace} from 'https://esm.sh/hast-util-whitespace@2'
In browsers with esm.sh
:
<script type="module">
import {whitespace} from 'https://esm.sh/hast-util-whitespace@2?bundle'
</script>
Use
import {whitespace} from 'hast-util-whitespace'
whitespace({
type: 'element',
tagName: 'div',
children: []
})
whitespace({
type: 'text',
value: '\t \n'
})
whitespace({
type: 'text',
value: ' text\f'
})
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
(unknown
, optional)
— thing to check (typically Node
or string
)
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 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-whitespace
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