Class default

Utility class for dealing with (zipped) files.

Index

Constructors

Methods

exists getZip isZipped putFileFromZip removeFolder removeZip

Constructors

constructor

new default(): default
Returns default

Methods

`Static` exists

exists(filePath): Promise<boolean>
Tests if a file path exists (and if the user is able to access it).
Parameters
- filePath: string
Returns Promise<boolean>
true if accessible; false otherwise
- Defined in src/lib/FolderUtil.ts:88

`Static` getZip

getZip(filePath): Promise<string>
Zips a file/directory.
Parameters
- filePath: string
  file/directory path
Returns Promise<string>
the file path of the resulting zip file

Static
Throws
thrown if zipping fails
- Defined in src/lib/FolderUtil.ts:35

`Static` isZipped

isZipped(filePath): Promise<boolean>
Determines if a file/path is a zip file.
Parameters
- filePath: string
  file/directory path
Returns Promise<boolean>
true if the file is zipped; false otherwise

Static
- Defined in src/lib/FolderUtil.ts:18

`Static` putFileFromZip

putFileFromZip(filePath, zipFilePath): Promise<unknown>
Unzips a zip file.
Parameters
- filePath: string
- zipFilePath: string
Returns Promise<unknown>
Static
Throws
file needs to exist

Throws
thrown if unzipping fails
- Defined in src/lib/FolderUtil.ts:108

`Static` removeFolder

removeFolder(filePath): Promise<void>
Deletes an (empty) folder.
Parameters
- filePath: string
  path to the directory
Returns Promise<void>
- Defined in src/lib/FolderUtil.ts:76

`Static` removeZip

removeZip(filePath): Promise<void>
Removes a zip file.
Parameters
- filePath: string
  file path excluding the .* at the end
Returns Promise<void>
Static
- Defined in src/lib/FolderUtil.ts:65

Generated using TypeDoc