Negatory. Postpone Mission.

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

    3.0.1 • Public • Published

    vfile-matter

    Build Coverage Downloads Size Sponsors Backers Chat

    Parse the YAML front matter in a vfile.

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

    Use

    Say we have a file, example.html:

    ---
    title: Hello, world!
    ---
    <p>Some more text</p>

    And our script, example.js, looks like so:

    import {toVFile as vfile} from 'to-vfile'
    import {matter} from 'vfile-matter'
    
    var file = vfile.readSync('example.html')
    
    matter(file, {strip: true})
    
    console.log(file.data)
    console.log(String(file))

    Now, running our script (node example) yields:

    {matter: {title: 'Hello, world!'}}
    <p>Some more text</p>

    API

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

    matter(file[, options])

    Parse the YAML front matter in a vfile, and add it as file.data.matter.

    If no matter is found in the file, nothing happens, except that file.data.matter is set to an empty object ({}).

    Parameters
    • file (VFile) — Virtual file
    • options.strip (boolean, default: false) — Remove the YAML front matter from the file
    • options.yaml (Object, default: {}) — Options passed to jsYaml.load()
    Returns

    The given file.

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

    DownloadsWeekly Downloads

    143

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    8.51 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm