Skip to content

πŸ“ Recursively create directories, like `mkdir -p`, and return a promise.

Notifications You must be signed in to change notification settings

simonlc/async-mkdirp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

21 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DEPRECATED

This project has been deprecated in favor of node's built in fsPromises.mkdir added in node v10.0.0

How to use node's built in method instead of this package:

const path = '/my/path/to/anything';
await fsPromises.mkdir(path, { recursive: true });

// With mode
const path = '/my/path/to/anything';
await fsPromises.mkdir(path, { recursive: true, mode: 0o775 });

// With partial application proposal
const path = '/my/path/to/anything';
const mkdirp = fsPromises.mkdir(?, { recursive: true, mode: 0o775 });
await mkdirp(path);

// Partial application with arrow functions
const path = '/my/path/to/anything';
const mkdirp = path => fsPromises.mkdir(path, { recursive: true, mode: 0o775 }));
await mkdirp(path);

async-mkdirp

npm npm bundle size (minified + gzip) npm downloads

Recursively create directories, like mkdir -p, and return a promise.

Install

npm install -S async-mkdirp

Usage

Normal:

const mkdirp = require('async-mkdirp');

(async () => {
  await mkdirp('/tmp/foo/bar/baz');
  // Code here runs after all directories have been created
})();

Make multiple paths in parallel:

const mkdirp = require('async-mkdirp');

const createDirs = async () => {
  await Promise.all([
    mkdirp('/tmp/foo/bar/baz'),
    mkdirp('./my/cool/folder'),
  ]);
  // Code here runs after all directories have been created
}

createDirs();

API

mkdir(path[, mode])

  • path <String> | <Buffer>
  • mode <Integer>

Asynchronous mkdir -p. mode defaults to 0o777.

About

This project is inspired by substack/mkdirp. It has been rewritten to take advantage of async functions, and does not include a synchronous method or cli.

Similar projects

  • node-mkdirp - callback style mkdirp, with cli
  • mkdirp-promise - node-mkdirp wrapped in a promise
  • mkdirp-then - node-mkdirp wrapped in a promise, and any-promise for promise implementation

License

MIT

About

πŸ“ Recursively create directories, like `mkdir -p`, and return a promise.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published