Function emptyDirectory

emptyDirectory(dirpath, predicate?): Promise<void>
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.

Pass a predicate function to remove only certain files from the directory.
Parameters
- dirpath: string
  
  The path of the directory to wipe.
- Optional predicate: ((stats) => boolean | Promise<boolean>)
  
  If the function returns true for a file, that file is removed from the directory.
  - - (stats): boolean | Promise<boolean>
    - Parameters
      
      stats: Stats & {
      name: string;
      get path(): string;
      }
      
      Returns boolean | Promise<boolean>
Returns Promise<void>
- Defined in packages/util/src/fs/emptyDirectory/emptyDirectory.ts:14

Generated using TypeDoc