capacitor-zip4j

capacitor plugin for zip4j (android only)

Install

npm install capacitor-zip4j
npx cap sync

API

• extractAll(...)
• extractFile(...)
• removeFiles(...)
• renameFile(...)
• mergeSplitFiles(...)
• getAllFileNames(...)
• isEncrypted(...)
• isSplitArchive(...)
• setComment(...)
• getComment(...)
• containsFile(...)
• addFiles(...)
• addFolder(...)
• createSplitZipFile(...)
• addListener('extractAllProgressEvent' | 'renameFileProgressEvent' | 'removeFilesProgressEvent' | 'mergeSplitFilesProgressEvent' | 'setCommentProgressEvent' | 'addFilesProgressEvent' | 'addFolderProgressEvent' | 'createSplitZipFileProgressEvent', ...)
• Interfaces

extractAll(...)

extractAll(options: { zipFilePath: string; destDirectory: string; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; destDirectory: string; password?: string; }

Returns: Promise<{ message: string; }>

---

extractFile(...)

extractFile(options: { zipFilePath: string; destDirectory: string; fileName: string; newFileName: string; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; destDirectory: string; fileName: string; newFileName: string; password?: string; }

Returns: Promise<{ message: string; }>

---

removeFiles(...)

removeFiles(options: { zipFilePath: string; fileNames: string[]; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; fileNames: string[]; password?: string; }

Returns: Promise<{ message: string; }>

---

renameFile(...)

renameFile(options: { zipFilePath: string; oldFile: string; newFile: string; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; oldFile: string; newFile: string; password?: string; }

Returns: Promise<{ message: string; }>

---

mergeSplitFiles(...)

mergeSplitFiles(options: { zipFilePath: string; newZipFilePath: string; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; newZipFilePath: string; password?: string; }

Returns: Promise<{ message: string; }>

---

getAllFileNames(...)

getAllFileNames(options: { zipFilePath: string; password?: string; }) => Promise<{ names: string[]; }>

Param	Type
options	{ zipFilePath: string; password?: string; }

Returns: Promise<{ names: string[]; }>

---

isEncrypted(...)

isEncrypted(options: { zipFilePath: string; }) => Promise<{ isEncrypted: boolean; }>

Param	Type
options	{ zipFilePath: string; }

Returns: Promise<{ isEncrypted: boolean; }>

---

isSplitArchive(...)

isSplitArchive(options: { zipFilePath: string; password?: string; }) => Promise<{ isSplitArchive: boolean; }>

Param	Type
options	{ zipFilePath: string; password?: string; }

Returns: Promise<{ isSplitArchive: boolean; }>

---

setComment(...)

setComment(options: { zipFilePath: string; comment: string; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; comment: string; password?: string; }

Returns: Promise<{ message: string; }>

---

getComment(...)

getComment(options: { zipFilePath: string; password?: string; }) => Promise<{ comment: string; }>

Param	Type
options	{ zipFilePath: string; password?: string; }

Returns: Promise<{ comment: string; }>

---

containsFile(...)

containsFile(options: { zipFilePath: string; fileName: string; password?: string; }) => Promise<{ contains: boolean; }>

Param	Type
options	{ zipFilePath: string; fileName: string; password?: string; }

Returns: Promise<{ contains: boolean; }>

---

addFiles(...)

addFiles(options: { zipFilePath: string; files: string[]; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; files: string[]; password?: string; }

Returns: Promise<{ message: string; }>

---

addFolder(...)

addFolder(options: { zipFilePath: string; folder: string; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; folder: string; password?: string; }

Returns: Promise<{ message: string; }>

---

createSplitZipFile(...)

createSplitZipFile(options: { zipFilePath: string; files: string[]; splitLength: number; password?: string; }) => Promise<{ message: string; }>

Param	Type
options	{ zipFilePath: string; files: string[]; splitLength: number; password?: string; }

Returns: Promise<{ message: string; }>

---

addListener('extractAllProgressEvent' | 'renameFileProgressEvent' | 'removeFilesProgressEvent' | 'mergeSplitFilesProgressEvent' | 'setCommentProgressEvent' | 'addFilesProgressEvent' | 'addFolderProgressEvent' | 'createSplitZipFileProgressEvent', ...)

addListener(eventName: 'extractAllProgressEvent' | 'renameFileProgressEvent' | 'removeFilesProgressEvent' | 'renameFileProgressEvent' | 'mergeSplitFilesProgressEvent' | 'setCommentProgressEvent' | 'addFilesProgressEvent' | 'addFolderProgressEvent' | 'createSplitZipFileProgressEvent', listenerFunc: (obj: { progress: number; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
eventName	'extractAllProgressEvent' | 'renameFileProgressEvent' | 'removeFilesProgressEvent' | 'mergeSplitFilesProgressEvent' | 'setCommentProgressEvent' | 'addFilesProgressEvent' | 'addFolderProgressEvent' | 'createSplitZipFileProgressEvent'
listenerFunc	(obj: { progress: number; }) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

---

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>