hast-util-heading-rank
hast utility to get the rank (or depth, level) of headings.
Install
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
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
hast-util-heading— check if a node is a heading elementhast-util-shift-heading— utility to change heading rank
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.