Zip Capacitor plugin

Using @capgo/capacitor-zip

Capacitor Zip Plugin for compressing and extracting zip archives.

Install

bun add @capgo/capacitor-zip
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { CapacitorZip } from '@capgo/capacitor-zip';

API at a glance

Examples

zip()

Compress a file or directory to create a ZIP archive.

import { CapacitorZip } from '@capgo/capacitor-zip';

// Compress a directory without password
await CapacitorZip.zip({
  source: '/path/to/my-folder',
  destination: '/path/to/output.zip'
});

unzip()

Extract a ZIP archive to a specified destination directory.

import { CapacitorZip } from '@capgo/capacitor-zip';

// Extract a standard ZIP archive
await CapacitorZip.unzip({
  source: '/path/to/archive.zip',
  destination: '/path/to/extract-folder'
});

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-zip

If you are using Using @capgo/capacitor-zip to plan native plugin work, connect it with @capgo/capacitor-zip for the implementation detail in @capgo/capacitor-zip, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.