hast utility to check if a node is inter-element whitespace
npm install hast-util-whitespace[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[hast][] utility to check if a node is [inter-element whitespace][spec].
* 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 to
HTML.
This utility is super niche, if you’re here you probably know what you’re
looking for!
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install hast-util-whitespace
In Deno with [esm.sh][esmsh]:
`js`
import {whitespace} from 'https://esm.sh/hast-util-whitespace@3'
In browsers with [esm.sh][esmsh]:
`html`
`js
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
`
This package exports the identifier [whitespace][api-whitespace].
There is no default export.
Check if the given value is [inter-element whitespace][spec].
###### Parameters
* thing ([Node][node] or string, optional)
— thing to check
###### Returns
Whether the value is inter-element whitespace (boolean): consisting of zero\t
or more of space, tab (), line feed (\n), carriage return (\r), or form\f
feed ().Text
If a node is passed it must be a [][text] node, whose value field is
checked.
This package is fully typed with [TypeScript][].
It exports no additional types.
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.
hast-util-whitespace does not change the syntax tree so there are no openings
for [cross-site scripting (XSS)][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
See [contributing.md][contributing] in [syntax-tree/.github][health] forsupport.md`][support] for ways to get help.
ways to get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/syntax-tree/hast-util-whitespace/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/hast-util-whitespace/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-whitespace.svg
[coverage]: https://codecov.io/github/syntax-tree/hast-util-whitespace
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-whitespace.svg
[downloads]: https://www.npmjs.com/package/hast-util-whitespace
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-whitespace
[size]: https://bundlejs.com/?q=hast-util-whitespace
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/syntax-tree/unist/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[license]: license
[author]: https://wooorm.com
[health]: https://github.com/syntax-tree/.github
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[hast]: https://github.com/syntax-tree/hast
[spec]: https://html.spec.whatwg.org/multipage/dom.html#inter-element-whitespace
[node]: https://github.com/syntax-tree/hast#nodes
[text]: https://github.com/syntax-tree/hast#text
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[api-whitespace]: #whitespacething