Nutella Pancake Machine

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

    3.0.0 • Public • Published

    vfile-mkdirp

    Build Coverage Downloads Sponsors Backers Chat

    Make sure the directory to a vfile exists.

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

    Use

    import {toVFile as vfile} from 'to-vfile'
    import {mkdirp} from 'vfile-mkdirp'
    
    var file = vfile('a/deep/path/to/docs/readme.md')
    
    try {
      await vfile.write(file)
    } catch (error) {
      console.log(error)
      // [Error: ENOENT: no such file or directory, open '~/a/deep/path/to/docs/readme.md']
    }
    
    await mkdirp(file)
    await vfile.write(file)
    // Works!

    API

    This package exports the following identifiers: mkdirp, mkdirpSync. There is no default export.

    mkdirp(file[, mode|options][, callback])

    Make sure the directory to the given vfile exists. Passes mode or options through to mkdirp.

    If no callback is given, returns a promise that resolves to the given file, or rejects with an error.

    Parameters
    • file (VFile) — Virtual file
    • mode (string, optional) — Passed to mkdirp
    • options (Object, optional) — Passed to mkdirp
    • callback (Function, optional)
    Returns

    Promise or void.

    callback(error[, file])

    Callback called when done.

    Parameters
    • error (Error) — Error, when failed
    • file (VFile, optional) — Given file, when complete

    mkdirpSync(file[, mode|options])

    Like mkdirp(file[, mode|options]) but synchronous. Either throws an error or 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-mkdirp

    DownloadsWeekly Downloads

    180

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    9.38 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm