react-native-zip-stream

A React Native module for working with ZIP archives. This module allows you to list the contents of ZIP files, stream files from ZIP archives, create new ZIP files, and unzip files with progress tracking.

Table of Contents

• Installation
• Expo Compatibility
• Usage
  • List Zip Contents
  • Stream File from Zip
  • Unzip File
  • Create Zip File
  • Unzip File with Progress
• API Reference
  • listZipContents
  • streamFileFromZip
  • unzipFile
  • createZipFile
• Examples
  • List Zip Contents Example
  • Stream File from Zip Example
  • Unzip File Example
  • Create Zip File Example

Installation

To install the module, follow these steps:

1. Add the dependency to your project:

   npm install react-native-zip-stream

2. For iOS, install the required CocoaPods dependencies:

   cd ios
   pod install

Expo Compatibility

react-native-zip-stream can also be used in Expo projects with some additional configuration. If you're using Expo and want to access the app's local document directory (e.g., to read and write ZIP files), follow these steps:

1. Install the package:

   expo install react-native-zip-stream

2. Add the plugin configuration to your app.json:

   {
     "expo": {
       "plugins": ["./node_modules/react-native-zip-stream/plugin"]
     }
   }

3. Run expo prebuild to generate the necessary native code for your Expo project.

This setup ensures that the app has the correct permissions to access local files and manipulate ZIP files on both Android and iOS.

Usage

List Zip Contents

Lists the contents of a ZIP file. This function returns an array of file names contained within the ZIP archive.

Stream File from Zip

Streams a specific file from a ZIP archive. You can retrieve the file data in one of three formats: base64, arraybuffer, or string.

Unzip File

Extracts all the contents of a ZIP file to a specified destination directory.

Create Zip File

Creates a new ZIP file from the contents of a specified directory.

API Reference

listZipContents

Lists the contents of a ZIP file.

Parameters

• zipFilePath: string - The full path to the ZIP file.

Returns

• Promise<string[]> - A promise that resolves to an array of file names inside the ZIP file.

streamFileFromZip

Streams a specific file from the ZIP archive.

Parameters

• zipFilePath: string - The full path to the ZIP file.
• entryName: string - The name of the file within the ZIP archive to extract.
• type: string (optional, default: base64) - The format in which to return the file data. Can be base64, arraybuffer, or string.

Returns

• Promise<string | ArrayBuffer | Uint8Array> - A promise that resolves to the file content in the specified format.

unzipFile

Extracts all the contents of a ZIP file to a specified destination directory.

Parameters

• zipFilePath: string - The full path to the ZIP file.
• destinationPath: string - The path where the contents of the ZIP file should be extracted.

Returns

• Promise<boolean> - A promise that resolves to true if the operation is successful.

createZipFile

Creates a new ZIP file from the contents of a specified directory.

Parameters

• destinationPath: string - The full path where the ZIP file should be created.
• sourcePath: string - The path to the directory or file that should be zipped.

Returns

• Promise<boolean> - A promise that resolves to true if the ZIP file is created successfully.

Examples

List Zip Contents Example

import { listZipContents } from 'react-native-zip-stream';

const zipFilePath = '/path/to/your/zipfile.zip';

const exampleListZipContents = async () => {
  try {
    const fileNames = await listZipContents(zipFilePath);
    console.log('Files in ZIP:', fileNames);
  } catch (error) {
    console.error('Error listing ZIP contents:', error);
  }
};

Stream File from Zip Example

import { streamFileFromZip } from 'react-native-zip-stream';

const zipFilePath = '/path/to/your/zipfile.zip';
const entryName = 'fileInsideZip.txt';

const exampleStreamFile = async () => {
  try {
    const base64Data = await streamFileFromZip(
      zipFilePath,
      entryName,
      'base64'
    );
    console.log('Base64 Data:', base64Data);

    const arrayBufferData = await streamFileFromZip(
      zipFilePath,
      entryName,
      'arraybuffer'
    );
    console.log('ArrayBuffer Data:', new Uint8Array(arrayBufferData));

    const stringData = await streamFileFromZip(
      zipFilePath,
      entryName,
      'string'
    );
    console.log('String Data:', stringData);
  } catch (error) {
    console.error('Error streaming file:', error);
  }
};

Unzip File Example

import { unzipFile } from 'react-native-zip-stream';

const zipFilePath = '/path/to/your/zipfile.zip';
const destinationPath = '/path/to/extract/';

const exampleUnzipFile = async () => {
  try {
    const success = await unzipFile(zipFilePath, destinationPath);
    console.log('Unzip successful:', success);
  } catch (error) {
    console.error('Error unzipping file:', error);
  }
};

Create Zip File Example

import { createZipFile } from 'react-native-zip-stream';

const sourcePath = '/path/to/source/folder';
const destinationPath = '/path/to/output.zip';

const exampleCreateZipFile = async () => {
  try {
    const success = await createZipFile(destinationPath, sourcePath);
    console.log('Zip creation successful:', success);
  } catch (error) {
    console.error('Error creating zip file:', error);
  }
};