Function sevenUnzip

sevenUnzip(options: UnzipOptions): Promise<void>

Extracts files from a specified zipped file asynchronously.

Parameters

options: UnzipOptions
An object containing options for the extraction process.

Returns Promise<void>

Throws

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

Example

import { UnzipOptions, sevenUnzip } from 'cross-7zip';

async function extractFiles(): Promise<void> {
  try {
    const unzipOptions: UnzipOptions = {
      archive: 'example.7z',
      destination: './output'
    };

    await sevenUnzip(unzipOptions);
    console.log('Extraction completed successfully.');
  } catch (error) {
    console.error('An error occurred during extraction:', error);
  }
}

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