Socket
Socket
Sign inDemoInstall

hast-util-whitespace

Package Overview
Dependencies
2
Maintainers
2
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

hast-util-whitespace

hast utility to check if a node is inter-element whitespace


Version published
Maintainers
2
Weekly downloads
3,503,871
decreased by-9.61%

Weekly downloads

Package description

What is hast-util-whitespace?

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.

What are hast-util-whitespace's main functionalities?

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.');
}

Other packages similar to hast-util-whitespace

Readme

Source

hast-util-whitespace

Build Coverage Downloads Size Sponsors Backers Chat

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 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 or string, 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.

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

Keywords

FAQs

Last updated on 31 Jul 2023

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc