mkdir-p-bluebird

mkdir-p-bluebird

promise wrapper for a linux like mkdir -p that ignores EEXIST by default; uses mkdir-bluebird to create the fs.mkdir() promises.

table of contents

• installation
• usage
  • mkdirp( pathp[, mode][, ignore] )
  • default
  • set ignore to false
  • using node’s path module
• license

installation

npm install mkdir-p-bluebird

usage

mkdirp( pathp[, mode][, ignore] )

@param {string|buffer} pathp
@param {number} [mode = 0o777]
@param {boolean} [ignore = true] ignore `EEXIST` directory errors returned by `fs.mkdir()`
@returns {Array}

default

ignores EEXIST directory errors returned by fs.mkdir()

var mkdirp = require( 'mkdir-p-bluebird' );
var Promise = require( 'bluebird' );

Promsie.all( mkdirp( 'test-dir/sub/folder' ) )
  .then(
    /**
     * @param {Array} result
     * an array of booleans; each one representing the result of each mkdir() promise
     * created by mkdirp(). since we’re in then(), each result should be `true`
     */
    function( result ) {
      // handle success
    }
  )
  .catch(
    /**
     * @param {Error} err
     */
    function( err ) {
      // handle error
    }
  );

set ignore to false

acknowledges EEXIST directory errors returned by fs.mkdir()

var mkdirp = require( 'mkdir-p-bluebird' );
var Promise = require( 'bluebird' );

Promise.all( mkdirp( 'test-dir/sub/folder', null, false ) )
  .then(
    /**
     * @param {Array} result
     * an array of booleans; each one representing the result of each mkdir() promise
     * created by mkdirp(). since we’re in then(), each result should be `true`
     */
    function( result ) {
      // handle success
    }
  )
  .catch(
    /**
     * @param {Error} err
     */
    function( err ) {
      // handle error
    }
  );

using node’s path module

var mkdirp = require( 'mkdir-p-bluebird' );
var path = require( 'path' );
var Promise = require( 'bluebird' );
var dirpath = path.join( __dirname, 'test', 'test-dir' );

Promise.all( mkdirp( dirpath ) )
  .then(
    /**
     * @param {Array} result
     * an array of booleans; each one representing the result of each mkdir() promise
     * created by mkdirp(). since we’re in then(), each result should be `true`
     */
    function( result ) {
      // handle success
    }
  )
  .catch(
    /**
     * @param {Error} err
     */
    function( err ) {
      // handle error
    }
  );

license

MIT License