# unzip-crx-3

> Unzip chrome extension files

Latest version **0.2.0** (published 2018-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install unzip-crx-3
pnpm add unzip-crx-3
yarn add unzip-crx-3
bun add unzip-crx-3
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2018-08-29 |
| First published | 2018-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 53 |
| Author | Peerigon developers |
| Maintainers | brianbondy |
| Keywords | unzip, crx, chrome, extensions, zip |

## Links

- npm: https://www.npmjs.com/package/unzip-crx-3
- Repository: https://github.com/peerigon/unzip-crx
- Homepage: https://github.com/peerigon/unzip-crx#readme
- Issues: https://github.com/peerigon/unzip-crx/issues
- npm.io page: https://npm.io/package/unzip-crx-3

## Dependencies (3)

- [yaku](https://npm.io/package/yaku.md) ^0.16.6
- [jszip](https://npm.io/package/jszip.md) ^3.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2018-08-29

## README

# unzip-crx

__Unzip chrome extension files__

[![Build Status](https://travis-ci.org/peerigon/unzip-crx.svg?branch=master)](https://travis-ci.org/peerigon/unzip-crx) [![Dependency Status](https://david-dm.org/peerigon/unzip-crx.svg)](https://david-dm.org/peerigon/unzip-crx) [![Coverage Status](https://coveralls.io/repos/github/peerigon/unzip-crx/badge.svg?branch=master)](https://coveralls.io/github/peerigon/unzip-crx?branch=master)

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 lib is highly inspired by [crx2ff](https://github.com/abarreir/crx2ff) from [abarreir](https://github.com/abarreir), thanks!

## Installation

```
$ npm install unzip-crx
```

## Example

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

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

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

```

## API

### unzip(file[, destination])

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



## Contributing

From opening a bug report to creating a pull request: **every contribution is appreciated and welcome**. If you're planing to implement a new feature or change the api please create an issue first. This way we can ensure that your precious work is not in vain.

All pull requests should have 100% test coverage (with notable exceptions) and need to pass all tests.

- Call `npm test` to run the unit tests
- Call `npm run coverage` to check the test coverage (using [istanbuljs/nyc](https://github.com/istanbuljs/nyc))

## LICENSE

MIT

---
_Source: https://npm.io/package/unzip-crx-3 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._