hast-util-heading-rank

hast utility to get the rank (or depth, level) of headings

Usage no npm install needed!

<script type="module">
  import hastUtilHeadingRank from 'https://cdn.skypack.dev/hast-util-heading-rank';
</script>

README

hast-util-heading-rank

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to get the rank (or depth, level) of headings.

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

Use

var h = require('hastscript')
var rank = require('hast-util-heading-rank')

rank(h('p', 'Alpha')) //=> null
rank(h('h5', 'Alpha')) //=> 5

API

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

headingRank(node)

Get the rank (1 to 6) of headings (h1 to h6).

Parameters
  • node (Node) — Node to check
Returns

rank (number?) — Rank of the heading, or null if not a heading.

Security

hast-util-heading-rank does not mutate. 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