https://github.com/tomjs/unzip-crx
解压 Chrome 插件文件(*.crx)。unzip chrome extension files(*.crx).
https://github.com/tomjs/unzip-crx
chorme chrome-extension crx extension unzip
Last synced: about 1 month ago
JSON representation
解压 Chrome 插件文件(*.crx)。unzip chrome extension files(*.crx).
- Host: GitHub
- URL: https://github.com/tomjs/unzip-crx
- Owner: tomjs
- License: mit
- Created: 2023-11-29T13:44:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-12T13:12:39.000Z (11 months ago)
- Last Synced: 2025-03-29T01:41:28.901Z (2 months ago)
- Topics: chorme, chrome-extension, crx, extension, unzip
- Language: JavaScript
- Homepage:
- Size: 475 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @tomjs/unzip-crx
[](https://www.npmjs.com/package/@tomjs/unzip-crx)   [](https://www.jsdocs.io/package/@tomjs/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 @tomjs/unzip-crx
# yarn
yarn add @tomjs/unzip-crx
# npm
npm add @tomjs/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/@tomjs/unzip-crx) provided by [jsdocs.io](https://www.jsdocs.io).
- [index.d.ts](https://www.unpkg.com/browse/@tomjs/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()`).