deleteDir

Description

Deletes a directory if it exists. Resolves the dirPath parameter if deletion succeeded or rejects a ENOENT or DeletingDirError.

Parameter List	Returns	Rejection Errors
`dirPath: string` `tuple: Array (optional)`	`Promise<string \|\| Array>`	`DeletingDirError` `ENOENT`
Related Functions	Function Signature
`dirExists` `filterResolutionParam`	`function deleteDir(dirPath[, tuple]): Promise<string \|\| Array>`

Examples

import {deleteDir} from 'puddy-m/lib/fileFunctions' 

 deleteDir('path/to/existing/dir')
    .then(dirPath=>console.log(dirPath)) // prints 'path/to/existing/dir'

import {deleteDir} from 'puddy-m/lib/fileFunctions' 

 deleteDir(true)
    .catch(e=>e) // rejects an instance of ENOENT or DeletingDirError.

// Using it with tuple parameter
import {deleteDir} from 'puddy-m/lib/fileFunctions' 

 deleteDir('path/to/existing/dir', [])
    .then(tuple=>validateString("World", tuple))
    .then(([first, second])=> first + second) // 'path/to/existing/dirWorld'