Skip to main content
Capgo logo
← Back To Plugins

Using @capgo/capacitor-zip

Capacitor Zip Plugin for compressing and extracting zip archives.

Install

bun add @capgo/capacitor-zip
bunx cap sync

What This Plugin Exposes

  • zip - Compress a file or directory to create a ZIP archive.
  • unzip - Extract a ZIP archive to a specified destination directory.

Example Usage

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