Interface StormArchiveModule
Methods
compactArchive
- compactArchive(archivePath: string, options?: undefined | { rootDir?: undefined | string }): boolean
-
Parameters
-
archivePath: string
-
Optional options: undefined | { rootDir?: undefined | string }
Returns boolean
createArchive
- createArchive(archivePath: string, options?: undefined | { maxFileCount?: undefined | number; overwrite?: undefined | false | true; rootDir?: undefined | string; version?: 1 | 2 | 3 | 4 }): boolean
-
Parameters
-
archivePath: string
-
Optional options: undefined | { maxFileCount?: undefined | number; overwrite?: undefined | false | true; rootDir?: undefined | string; version?: 1 | 2 | 3 | 4 }
Returns boolean
listFiles
- listFiles(archivePath: string, mask?: undefined | string, options?: undefined | { maxEntries?: undefined | number }): StormArchiveEntry[]
-
Parameters
-
archivePath: string
-
Optional mask: undefined | string
-
Optional options: undefined | { maxEntries?: undefined | number }
readFile
- readFile(archivePath: string, fileName: string, options?: undefined | { maxBytes?: undefined | number }): Buffer
-
Parameters
-
archivePath: string
-
fileName: string
-
Optional options: undefined | { maxBytes?: undefined | number }
Returns Buffer
writeFile
- writeFile(archivePath: string, archivedName: string, data: Buffer, options?: undefined | { compression?: string | number | boolean; maxBytes?: undefined | number; replaceExisting?: undefined | false | true; rootDir?: undefined | string }): boolean
-
Parameters
-
archivePath: string
-
archivedName: string
-
data: Buffer
-
Optional options: undefined | { compression?: string | number | boolean; maxBytes?: undefined | number; replaceExisting?: undefined | false | true; rootDir?: undefined | string }
Returns boolean