Getting Started

설치

bun add @capgo/capacitor-zip
bunx cap sync

Import

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

API 개요

zip

파일이나 폴더를 압축하여 ZIP 아카이브를 생성합니다.

원본 파일 또는 폴더에서 ZIP 아카이브를 생성합니다. 아카이브에는 원본이 폴더일 경우 폴더 구조가 포함됩니다.

플랫폼별 참고사항:

• iOS: 암호 보호가 지원되지 않습니다. 암호가 제공되면 무시되고 경고 메시지가 로그에 기록됩니다.
• Android: 암호가 제공되면 AES-256 암호화가 지원됩니다.
• 웹: 지원되지 않습니다. 호출 시 오류가 발생합니다.

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

지정된 목적지 디렉토리로 ZIP 압축 파일을 추출합니다.

ZIP 압축 파일에서 모든 파일과 폴더를 추출하여 디렉토리 구조를 유지합니다. 목적지 디렉토리가 존재하지 않으면 생성합니다.

플랫폼별 참고사항:

• iOS: 표준 ZIP 압축 파일을 지원합니다. 제공된 암호로 암호화된 압축 파일을 추출합니다.
• Android: 암호화된 ZIP 파일을 지원합니다. 암호를 제공하면 암호화된 ZIP 파일을 추출합니다. zip slip 취약점 보호도 제공합니다.
• 웹: 파일을 개별적으로 다운로드하여 브라우저의 다운로드 폴더에 저장합니다. 디렉토리 구조를 생성할 수 없습니다.

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

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

타입 참조

ZipOptions

ZIP 아카이브를 생성하는 데 사용되는 옵션.

export interface ZipOptions {
  /**
   * Path to the file or directory to compress.
   *
   * This can be an absolute path or a path relative to the app's working directory.
   * If the source is a directory, all its contents will be recursively compressed
   * while preserving the directory structure.
   *
   * Platform-specific notes:
   * - iOS: Use file:// URLs or absolute paths. Relative paths are resolved from the app's documents directory.
   * - Android: Use absolute file paths or content:// URIs for files accessible via the Android Storage Access Framework.
   * - Web: Not supported.
   *
   * @since 7.0.0
   * @example '/Users/app/Documents/my-folder'
   * @example '/var/mobile/Containers/Data/Application/.../Documents/file.pdf'
   * @example 'file:///storage/emulated/0/Download/document.pdf'
   */
  source: string;

  /**
   * Path where the ZIP archive will be created.
   *
   * The destination path must include the .zip file extension. If the parent
   * directory doesn't exist, it will be created automatically.
   *
   * Platform-specific notes:
   * - iOS: Use file:// URLs or absolute paths. Relative paths are resolved from the app's documents directory.
   * - Android: Use absolute file paths. The plugin will create any missing parent directories.
   * - Web: Not supported.
   *
   * @since 7.0.0
   * @example '/Users/app/Documents/archive.zip'
   * @example '/var/mobile/Containers/Data/Application/.../Documents/backup.zip'
   * @example 'file:///storage/emulated/0/Download/compressed.zip'
   */
  destination: string;

  /**
   * Optional password for encrypting the ZIP archive.
   *
   * When provided, the archive will be encrypted and require this password
   * to extract. Uses AES-256 encryption on Android.
   *
   * Platform-specific notes:
   * - iOS: Password protection is NOT supported. The password will be ignored and a warning will be logged.
   * - Android: Supports AES-256 encryption via zip4j library. The password must be provided during extraction.
   * - Web: Not supported.
   *
   * @since 7.0.0
   * @example 'mySecurePassword123'
   */
  password?: string;

  /**
   * Whether to include the parent folder in the ZIP archive.
   *
   * When true (default), the source folder itself becomes the root directory in the archive.
   * When false, only the contents of the source folder are included at the root level.
   *
   * This option only applies when the source is a directory. For single files, this option is ignored.
   *
   * @default true
   * @since 8.0.5
   * @example
   * ```typescript
   * // With includeParentFolder: true (default)
   * // Source: /cache/temp/ containing [database.backup, media/]
   * // ZIP contains: temp/database.backup, temp/media/
   * await CapacitorZip.zip({
   *   source: '/cache/temp',
   *   destination: '/cache/backup.zip',
   *   includeParentFolder: true
   * });
   * ```
   * @example
   * ```typescript
   * // With includeParentFolder: false
   * // Source: /cache/temp/ containing [database.backup, media/]
   * // ZIP contains: database.backup, media/
   * await CapacitorZip.zip({
   *   source: '/cache/temp',
   *   destination: '/cache/backup.zip',
   *   includeParentFolder: false
   * });
   * ```
   */
  includeParentFolder?: boolean;
}

UnzipOptions

ZIP 아카이브를 추출하는 데 사용되는 옵션.

export interface UnzipOptions {
  /**
   * Path to the ZIP archive to extract.
   *
   * The source must be a valid ZIP file. If the file doesn't exist or is
   * corrupted, the operation will fail with an error.
   *
   * Platform-specific notes:
   * - iOS: Use file:// URLs or absolute paths. Relative paths are resolved from the app's documents directory.
   * - Android: Use absolute file paths or content:// URIs for files accessible via the Android Storage Access Framework.
   * - Web: Use HTTP/HTTPS URLs. The file will be fetched and extracted in the browser.
   *
   * @since 7.0.0
   * @example '/Users/app/Documents/archive.zip'
   * @example '/var/mobile/Containers/Data/Application/.../Documents/backup.zip'
   * @example 'file:///storage/emulated/0/Download/compressed.zip'
   * @example 'https://example.com/files/archive.zip' (Web only)
   */
  source: string;

  /**
   * Path to the directory where files will be extracted.
   *
   * The destination directory will be created if it doesn't exist. All files
   * and folders from the archive will be extracted while preserving the
   * directory structure.
   *
   * Platform-specific notes:
   * - iOS: Use file:// URLs or absolute paths. Relative paths are resolved from the app's documents directory.
   * - Android: Use absolute file paths. Includes protection against zip slip vulnerabilities.
   * - Web: Not applicable. Files are downloaded individually to the browser's download folder.
   *
   * @since 7.0.0
   * @example '/Users/app/Documents/extracted'
   * @example '/var/mobile/Containers/Data/Application/.../Documents/files'
   * @example 'file:///storage/emulated/0/Download/extracted-files'
   */
  destination: string;

  /**
   * Optional password for decrypting password-protected archives.
   *
   * Required if the ZIP archive was encrypted with a password. If the password
   * is incorrect, extraction will fail with an error.
   *
   * Platform-specific notes:
   * - iOS: Supports password-protected ZIP archives.
   * - Android: Supports AES-encrypted archives created with zip4j or standard password-protected ZIPs.
   * - Web: Not supported. Password-protected archives cannot be extracted in the browser.
   *
   * @since 7.0.0
   * @example 'mySecurePassword123'
   */
  password?: string;
}

실제 데이터 원천

이 페이지는 플러그인의 src/definitions.tsAPI이 업스트림에서 변경될 때마다 다시 동기화하십시오.

Getting Started에서 계속

만약 __CAPGO_KEEP_0__을 사용하고 있다면 Getting Started API 대시보드를 계획하고 API 연산을 위해 연결하세요. Using @capgo/capacitor-zip capgo의 네이티브 기능을 사용하기 위해 Using @capgo/capacitor-zip을 사용하세요. API 개요 API의 구현 세부 정보를 확인하세요. 소개 소개의 구현 세부 정보를 확인하세요. API 키 API 키의 구현 세부 정보를 확인하세요. 장치 __CAPGO_KEEP_0__