FIX: Minor docs changes
This commit is contained in:
parent
f9d16ddce9
commit
714fd79f58
@ -6,7 +6,6 @@ import archiver from "archiver";
|
|||||||
* Append a file from the path to the archiver. Errors will be bubbled out
|
* Append a file from the path to the archiver. Errors will be bubbled out
|
||||||
* @param filePath Target path
|
* @param filePath Target path
|
||||||
* @param archive The archiver
|
* @param archive The archiver
|
||||||
* @constructor
|
|
||||||
*/
|
*/
|
||||||
export function appendFileToArchive(filePath: string, archive: archiver.Archiver): void {
|
export function appendFileToArchive(filePath: string, archive: archiver.Archiver): void {
|
||||||
try {
|
try {
|
||||||
@ -18,10 +17,10 @@ export function appendFileToArchive(filePath: string, archive: archiver.Archiver
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Recursively append directories to
|
* Recursively append directories to the archiver
|
||||||
* @param filePath
|
* @param filePath Target path
|
||||||
* @param archiveRelPath
|
* @param archiveRelPath Relative path to the current archive
|
||||||
* @param archive
|
* @param archive The archiver
|
||||||
*/
|
*/
|
||||||
export function appendDirectoryToArchive(filePath: string, archiveRelPath: string = "", archive: archiver.Archiver): void {
|
export function appendDirectoryToArchive(filePath: string, archiveRelPath: string = "", archive: archiver.Archiver): void {
|
||||||
try {
|
try {
|
||||||
@ -49,8 +48,6 @@ export function appendDirectoryToArchive(filePath: string, archiveRelPath: strin
|
|||||||
appendDirectoryToArchive(fullPath, relPath, archive);
|
appendDirectoryToArchive(fullPath, relPath, archive);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
throw new Error(`Error appending directory to archive: ${error}`);
|
throw new Error(`Error appending directory to archive: ${error}`);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user