make-dir
Make a directory and its parents if needed - Think
mkdir -p
Tip
You probably want the built-in fsPromises.mkdir('...', {recursive: true}) instead.
Advantages over fsPromises.mkdir('...', {recursive: true})
- Supports a custom
fsimplementation.
Advantages over mkdirp
- Promise API (Async/await ready!)
- Fixes many
mkdirpissues - CI-tested on macOS, Linux, and Windows
- Actively maintained
- Doesn't bundle a CLI
- Uses the native
fs.mkdir/mkdirSyncrecursiveoption in Node.js unless overridden
Install
npm install make-dir
Usage
$ pwd
/Users/sindresorhus/fun
$ tree
.
/Users/sindresorhus/fun
$ tree
.
'/Users/sindresorhus/fun/unicorn/rainbow/cake'">import {makeDirectory} from 'make-dir';
const path = await makeDirectory('unicorn/rainbow/cake');
console.log(path);
//=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
const path = await makeDirectory('unicorn/rainbow/cake');
console.log(path);
//=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
$ tree
.
+-- unicorn
+-- rainbow
+-- cake
.
+-- unicorn
+-- rainbow
+-- cake
Multiple directories:
import {makeDirectory} from 'make-dir';
const paths = await Promise.all([
makeDirectory('unicorn/rainbow'),
makeDirectory('foo/bar')
]);
console.log(paths);
/*
[
'/Users/sindresorhus/fun/unicorn/rainbow',
'/Users/sindresorhus/fun/foo/bar'
]
*/
const paths = await Promise.all([
makeDirectory('unicorn/rainbow'),
makeDirectory('foo/bar')
]);
console.log(paths);
/*
[
'/Users/sindresorhus/fun/unicorn/rainbow',
'/Users/sindresorhus/fun/foo/bar'
]
*/
API
makeDirectory(path, options?)
Returns a Promise for the path to the created directory.
makeDirectorySync(path, options?)
Returns the path to the created directory.
path
Type: string | URL
The directory to create.
options
Type: object
mode
Type: integer
Default: 0o777
The directory permissions.
fs
Type: object
Default: import fs from 'node:fs'
Use a custom fs implementation. For example graceful-fs.
Using a custom fs implementation will block the use of the native recursive option if fs.mkdir or fs.mkdirSync is not the native function.