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

    2.0.0 • Public • Published

    hast-util-heading

    Build Coverage Downloads Size Sponsors Backers Chat

    hast utility to check if an element is a heading.

    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-heading

    Use

    import {heading} from 'hast-util-heading'
    
    // Given a non-heading value:
    heading({
      type: 'element',
      tagName: 'a',
      properties: {href: '#alpha', title: 'Bravo'},
      children: [{type: 'text', value: 'Charlie'}]
    }) // => false
    
    // Given a heading element:
    heading({
      type: 'element',
      tagName: 'h1',
      children: [{type: 'text', value: 'Delta'}]
    }) // => true

    API

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

    heading(node)

    Check if the given value is a heading element.

    Security

    hast-util-heading 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-heading

    DownloadsWeekly Downloads

    1,700

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.55 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck