promise wrapper for node’s fs.mkdir() that ignores EEXIST by default


Keywords
bluebird, fs, mkdir, promise
License
MIT
Install
npm install mkdir-bluebird@1.0.14

Documentation

mkdir-bluebird

NPM version Build Status Coverage Status Dependency Status NSP Status

promise wrapper for node’s fs.mkdir() that ignores EEXIST by default.

wraps node’s fs.mkdir(), in a bluebird promise that resolves with true if successful or rejects with the Error returned by fs.mkdir(); both results need to be handled by the code calling this function.

table of contents

installation

npm install mkdir-bluebird

usage

mkdir( path[, mode][, ignore] )

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

default

ignores EEXIST directory errors returned by fs.mkdir()

var mkdir = require( 'mkdir-bluebird' );

mkdir( 'test-dir' )
  .then(
    /**
     * @param {boolean} result
     */
    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 mkdir = require( 'mkdir-bluebird' );

mkdir( 'test-dir', null, false )
  .then(
    /**
     * @param {boolean} result
     */
    function( result ) {
      // handle success
    }
  )
  .catch(
    /**
     * @param {Error} err
     */
    function( err ) {
      // handle error
    }
  );

using node’s path module

the path __dirname/test must exist in order to create the directory test-dir in it

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

mkdir( dirpath )
  .then(
    /**
     * @param {boolean} result
     */
    function( result ) {
      // handle success
    }
  )
  .catch(
    /**
     * @param {Error} err
     */
    function( err ) {
      // handle error
    }
  );

license

MIT License