vfile-mkdirp
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatMake sure the directory to a
vfile
vfile exists.Install
This package is ESM only: Node 12+ is needed to use it and it must beimport
ed instead of require
d.npm install vfile-mkdirp
## Use
```js
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
vfile exists.
Passes mode
or options
through to mkdirp
mkdirp.If no callback is given, returns a promise that resolves to the given file, or rejects with an error.
Parameters
file
(VFile
vfile) — Virtual filemode
(string
, optional) — Passed tomkdirp
mkdirpoptions
(Object
, optional) — Passed tomkdirp
mkdirpcallback
(Function
callback, optional)
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
Seecontributing.md
contributing in vfile/.github
health for ways to
get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.