deleteDir

Category: Directory Operations

Namespace: web.directory.deleteDir

Description

Deletes an empty directory. This is a safe operation that will fail if the directory contains any files or subdirectories.

Syntax

const success = await web.directory.deleteDir({
    dirPath: 'path/to/directory'
});

Parameters

• dirPath (required) - Directory path to delete (relative or absolute)

Returns

Promise<boolean> - Returns a promise that resolves with true if the directory was deleted successfully, false otherwise

Examples

Simple example

const success = await web.directory.deleteDir({
    dirPath: 'C:\\EmptyFolder'
});

if (success) {
    console.log('Directory deleted');
} else {
    console.log('Failed to delete (directory may not be empty)');
}

Safe deletion with verification

const dirPath = 'temp_folder';

// Verify it exists first
const exists = await web.directory.dirExists({ dirPath });

if (exists) {
    const success = await web.directory.deleteDir({ dirPath });
    if (success) {
        console.log('Directory deleted successfully');
    } else {
        console.log('Directory is not empty');
    }
}

Use Cases

• Clean up empty temporary directories
• Remove directories after moving their contents
• Safely delete directories without risking data loss

Notes

• SAFETY FEATURE: Only deletes empty directories
• Returns false if the directory contains any files or subdirectories
• Use deleteDirRecursively() if you need to delete non-empty directories
• Returns false if the directory doesn't exist