hast-util-whitespace
Advanced tools
Package description
The `hast-util-whitespace` package is a utility for working with whitespace in HAST (Hypertext Abstract Syntax Tree) nodes. HAST is part of the unifiedjs ecosystem, which is used for processing HTML, Markdown, and similar content. This package provides functionality to check if a node is whitespace, which can be useful in various text processing and manipulation tasks in the context of web content.
Check if a node is whitespace
This feature allows you to check if a given HAST node is composed entirely of whitespace. The function returns `true` if the node is a whitespace node, and `false` otherwise. This can be particularly useful when manipulating or traversing HAST trees, allowing for the exclusion or special handling of whitespace nodes.
var whitespace = require('hast-util-whitespace');
var node = {type: 'text', value: ' '};
if (whitespace(node)) {
console.log('The node is whitespace.');
} else {
console.log('The node is not whitespace.');
}While not exclusively focused on whitespace, `unist-util-visit` is a utility for traversing Unist nodes, which are part of the same ecosystem as HAST nodes. It can be used in conjunction with `hast-util-whitespace` to visit nodes in a HAST tree and perform actions based on whether they are whitespace or not. This package provides broader functionality for node traversal and manipulation.
This package is part of the rehype ecosystem, which is built on top of unified and HAST for HTML processing. `rehype-minify-whitespace` focuses on minimizing whitespace in HTML documents to reduce file size. While it deals with whitespace, its primary goal is optimization rather than the detection or manipulation of whitespace nodes per se, making it a complementary tool for different use cases.
Readme
hast utility to check if a node is inter-element
whitespace.
npm:
npm install hast-util-whitespace
var whitespace = require('hast-util-whitespace')
whitespace({
type: 'element',
tagName: 'div',
children: []
}) // => false
whitespace({
type: 'text',
value: '\t \n'
}) // => true
whitespace({
type: 'text',
value: ' text\f'
}) // => false
whitespace(node|value)Check if the given value is inter-element whitespace.
node (Node, optional) — Node to checkvalue (string, optional) — Value to checkboolean — Whether the value is inter-element white-space: consisting of zero
or more of space, tab (\t), line feed (\n), carriage return (\r), or form
feed (\f).
If node is passed it must be a text node.
hast-util-whitespace does not change the syntax tree so there are no openings
for cross-site scripting (XSS) attacks.
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.
FAQs
hast utility to check if a node is inter-element whitespace
The npm package hast-util-whitespace receives a total of 2,250,458 weekly downloads. As such, hast-util-whitespace popularity was classified as popular.
We found that hast-util-whitespace demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.