hast-util-whitespace

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

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install hast-util-whitespace

Use

import {whitespace} from 'hast-util-whitespace'

whitespace({
  type: 'element',
  tagName: 'div',
  children: []
}) // => false

whitespace({
  type: 'text',
  value: '\t  \n'
}) // => true

whitespace({
  type: 'text',
  value: '  text\f'
}) // => false

API

This package exports the following identifiers: whitespace. There is no default export.

whitespace(node|value)

Check if the given value is inter-element whitespace.

Parameters

• node (Node, optional) — Node to check
• value (string, optional) — Value to check

Returns

boolean — 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.

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

Current Tags

• 2.0.1                                ...           latest (3 years ago)

3 Versions

• 2.0.1                                ...           3 years ago
• 2.0.0                                ...           4 years ago
• 1.0.4                                ...           6 years ago