unified

Project:syntax-tree/hast-util-whitespace

Package:hast-util-whitespace@1.0.4

  1. Dependencies:0·Dependents:9
  2. hast utility to check if a node is inter-element whitespace
  1. util 105
  2. utility 105
  3. html 100
  4. unist 90
  5. hast 51
  6. hast-util 40
  7. whitespace 6
  8. element 5

hast-util-whitespace

Build Coverage Downloads Size Sponsors Backers Chat

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

Install

npm:

npm install hast-util-whitespace

Use

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

API

whitespace(node|value)

Check if the given value is inter-element whitespace.

Parameters
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.

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