"Fossies" - the Fresh Open Source Software Archive

Member "node-v12.18.4-win-x86/node_modules/npm/node_modules/make-dir/readme.md" (14 Feb 2020, 2810 Bytes) of package /windows/www/node-v12.18.4-win-x86.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

make-dir Build Status: macOS & Linux Build status: Windows codecov

Make a directory and its parents if needed - Think mkdir -p

Advantages over mkdirp

Install

$ npm install make-dir

Usage

$ pwd
/Users/sindresorhus/fun
$ tree
.
const makeDir = require('make-dir');

makeDir('unicorn/rainbow/cake').then(path => {
    console.log(path);
    //=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
});
$ tree
.
└── unicorn
    └── rainbow
        └── cake

Multiple directories:

const makeDir = require('make-dir');

Promise.all([
    makeDir('unicorn/rainbow')
    makeDir('foo/bar')
]).then(paths => {
    console.log(paths);
    /*
    [
        '/Users/sindresorhus/fun/unicorn/rainbow',
        '/Users/sindresorhus/fun/foo/bar'
    ]
    */
});

API

makeDir(path, options)

Returns a Promise for the path to the created directory.

makeDir.sync(path, options)

Returns the path to the created directory.

path

Type: string

Directory to create.

options

Type: Object

mode

Type: integer
Default: 0o777 & (~process.umask())

Directory permissions.

fs

Type: Object
Default: require('fs')

Use a custom fs implementation. For example graceful-fs.

License

MIT © Sindre Sorhus