deleteFile

Description

Deletes a file if it exists. If deletion succeed, it will resolve the fileLocationAndName parameter. If it fails, it will reject either a StringValidationError, ENOENT or a DeletingFileError.

Parameter List	Returns	Rejection Errors
`fileLocationAndName: string` `tuple: Array (optional)`	`Promise<string \|\| Array>`	`ENOENT` `NotExistingFileError` `DeletingFileError`
Related Functions	Function Signature
`validatedString` `fileExists` `filterResolutionParam`	`function deleteFile(fileLocationAndName[, tuple]): Promise<string \|\| Array>`

Examples

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

 deleteFile('path/to/file.ext')
    .then(filePath=>console.log(filePath)) // prints 'path/to/file.ext'

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

 deleteFile(true)
    .catch(e=>e) // rejects an instance of StringValidationError.

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

 deleteFile('path/to/file.ext', [])
    .then(tuple=>validateString("World", tuple))
    .then(([first, second])=> first + second) // 'path/to/file.extWorld'