UseRemoveDir
katanakit-js / useRemoveDir
Function: useRemoveDir()
Section titled “Function: useRemoveDir()”function useRemoveDir(path, options?): Promise<FilesystemResult<string>>;Defined in: infrastructure/filesystem/filesystem.service.ts:497
Removes a directory tree. Recursive by default; force: false
surfaces ENOENT instead of ignoring missing paths.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
path |
string |
Directory path to remove. |
options? |
{ force?: boolean; recursive?: boolean; } |
recursive (default true) and force (default false). |
options.force? |
boolean |
- |
options.recursive? |
boolean |
- |
Returns
Section titled “Returns”Promise<FilesystemResult<string>>
Safe Result with the removed path.
Example
Section titled “Example”await useRemoveDir("data/cache");