Nihilist Postmodern Mistake
    Wondering what’s next for npm?Check out our public roadmap! »

    mdast-util-compact
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0 • Public • Published

    mdast-util-compact

    Build Coverage Downloads Size Sponsors Backers Chat

    mdast utility to make trees compact: collapse adjacent text nodes and blockquotes.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install mdast-util-compact

    Use

    import {u} from 'unist-builder'
    import {compact} from 'mdast-util-compact'
    
    var tree = u('strong', [u('text', 'alpha'), u('text', ' '), u('text', 'bravo')])
    
    compact(tree)
    
    console.log(tree)

    Yields:

    {
      type: 'strong',
      children: [ { type: 'text', value: 'alpha bravo' } ]
    }

    API

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

    compact(tree)

    Walk the tree and collapse nodes. Combines adjacent texts and collapses blockquotes.

    Handles positional information properly.

    Returns

    The given tree.

    Security

    Use of mdast-util-compact does not involve hast or user content 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 mdast-util-compact

    DownloadsWeekly Downloads

    1,653,973

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    8.1 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar