unified

Project: vfile/vfile-mkdirp

Package: vfile-mkdirp@3.0.0

  1. Dependents: 0
  2. vfile utility to make sure the directory of a file exists on the file system
  1. util 143
  2. utility 139
  3. file 34
  4. virtual 19
  5. vfile 17
  6. vfile-util 15
  7. path 3

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
Returns

Promise or void.

callback(error[, file])

Callback called when done.

Parameters

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