vfile-statistics
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    vfile-statistics

    Build Coverage Downloads Size Sponsors Backers Chat

    Count vfile messages per category (fatal, warn, info, nonfatal and total).

    Install

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

    npm:

    npm install vfile-statistics

    Use

    import {VFile} from 'vfile'
    import {statistics} from 'vfile-statistics'
    
    var file = new VFile({path: '~/example.md'})
    
    file.message('This could be better')
    file.message('That could be better')
    
    try {
      file.fail('This is terribly wrong')
    } catch (err) {}
    
    file.info('This is perfect')
    
    console.log(statistics(file))

    Yields:

    {fatal: 1, nonfatal: 3, warn: 2, info: 1, total: 4}

    API

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

    statistics(file)

    Pass a vfile, list of vfiles, or a list of messages (file.messages), get counts per category.

    Returns

    Object:

    • fatal: fatal errors (fatal: true)
    • warn: warning messages (fatal: false)
    • info: informational messages (fatal: null or fatal: undefined)
    • nonfatal: warning or info messages
    • total: all messages

    Contribute

    See contributing.md in vfile/.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 vfile-statistics

    DownloadsWeekly Downloads

    204,661

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    8.91 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm