@equicord/unzip-crx/README.md

unzip chrome extension files (*.crx)

# @equicord/unzip-crx

[![npm](https://img.shields.io/npm/v/@equicord/unzip-crx)](https://www.npmjs.com/package/@equicord/unzip-crx) ![node-current (scoped)](https://img.shields.io/node/v/@equicord/unzip-crx) ![NPM](https://img.shields.io/npm/l/@equicord/unzip-crx) [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@equicord/unzip-crx)

**English** | [中文](./README.zh_CN.md)

> Unzip chrome extension files

If you want to unzip [Chrome extension files](https://developer.chrome.com/extensions) (\*.crx) you might have the problem that your unzip lib claims that the file header is malformed. This is due to that Chrome [adds some extra information](https://developer.chrome.com/extensions/crx) for identifying crx files. `unzip-crx` handles those additional headers and unzips as usual.

This library is based on [Peerigon](https://github.com/peerigon)'s [unzip-crx](https://github.com/peerigon/unzip-crx), which makes simple modifications and adds `esm` and `cjs` support.

And this [unzip-crx](https://github.com/peerigon/unzip-crx) is highly inspired by [crx2ff](https://github.com/abarreir/crx2ff) from [abarreir](https://github.com/abarreir) and [crxviewer](https://github.com/Rob--W/crxviewer) from [Rob Wu](https://github.com/Rob--W), thanks!

## Install

```bash
# pnpm
pnpm add @equicord/unzip-crx

# yarn
yarn add @equicord/unzip-crx

# npm
npm add @equicord/unzip-crx
```

## Example

- `esm`

```js
import unzip from 'unzip-crx';

const crxFile = './this-chrome-extension.crx';

unzip(crxFile).then(() => {
  console.log('Successfully unzipped your crx file..');
});
```

- `cjs`

```js
const unzip = require('unzip-crx');

const crxFile = './this-chrome-extension.crx';

unzip(crxFile).then(() => {
  console.log('Successfully unzipped your crx file..');
});
```

## Documentation

- [API Document](https://www.jsdocs.io/package/@equicord/unzip-crx) provided by [jsdocs.io](https://www.jsdocs.io).
- [index.d.ts](https://www.unpkg.com/browse/@equicord/unzip-crx/dist/index.d.ts) provided by [unpkg.com](https://www.unpkg.com).

## API

### unzip(file[, destination])

- `file`: string, the path to the file to unzip
- `destination`: string, the path to the destination folder (optional)

Resolves with a Promise if the file was unzipped successfully, throws otherwise (use `.catch()`).