Nothing Precedes Matter

    hast-util-whitespace
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    hast-util-whitespace

    Build Coverage Downloads Size Sponsors Backers Chat

    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

    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

    Install

    npm i hast-util-whitespace

    DownloadsWeekly Downloads

    999,781

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.38 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck