Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.22 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.22 KB

@fibjs/mkdirp

NPM version build status appveyor build status Test coverage David deps Known Vulnerabilities npm download

Like mkdir -p, but in fibjs!

Install

$ npm i @fibjs/mkdirp --save

Usage

const mkdirp = require('@fibjs/mkdirp');

try{
	mkdirp('/tmp/a/c/d')
} catch(err) {
	console.error(err)
}

then /tmp/a/c/d has beed created.

API

  • mkdirp(dir, opts)

asynchronously create a new directory and any necessary subdirectories at dir with octal permission string opts.mode. If opts is a non-object, it will be treated as the opts.mode.

If opts.mode isn't specified, it defaults to 0777 & (~process.umask()).

Returns the first directory that had to be created, if any.

You can optionally pass in an alternate fs implementation by passing in opts.fs. Your implementation should have opts.fs.mkdir(path, mode) and opts.fs.stat(path).

Questions & Suggestions

Please open an issue here.

License

MIT