Function sevenZip

sevenZip(options: ZipOptions): Promise<void>

Compresses multiple files into a zipped file asynchronously.

Parameters

options: ZipOptions
An object containing options for the compression process.

Returns Promise<void>

Throws

Will throw an error if the 7-Zip executable is not found.

Example

import { ZipOptions, sevenZip } from 'cross-7zip';

async function createArchive(): Promise<void> {
  try {
    const zipOptions: ZipOptions = {
      destination: 'example.7z',
      files: ['document.txt', 'image.png', 'folder']
    };

    await sevenZip(zipOptions);
    console.log('Archive created successfully.');
  } catch (error) {
    console.error('An error occurred during compression:', error);
  }
}

For additional examples, see the sevenZipUnzip.test.ts.