This module has been developed for a specific use case (unzipping specific files with a flexible API). It supports only the most common compression method deflate. There are some missing features, such as CRC check, encrypted files, and ZIP 64 support. I plan to add them later. if you like this and want to enhance/add missing features or add more public functions, feel free to come up with a pull request, but before doing that, please check CONTRIBUTING.md
Most of the open-source ZIP libraries are written in old javascript, weakly tested, not well structured, and mostly depending on other open-source libraries, which makes it hard to manage, perform patches, and updates. This module is written in Typescript. Which allows to create more abstractions around the idea, provides type checking and OOP capabilities.
- Fully typed thanks to Typescript
- 0 external dependencies
- Easy to scale
- Easy to test
- Flexible API
Implement CRC-32 check- Add support for encrypted ZIPs
- Add support for more compression methods
- Add support for ZIP64
- Add zipping functionality
- Add streaming API
- Add more unit tests
npm install node-hk-zip
yarn add node-hk-zip
import fs from 'fs';
import {ZipFile, ZipEntry} from 'node-hk-zip';
const data: Buffer = fs.readFileSync('..some zip file path'); // IMPORTANT: Usage of sync method for demo purposes only
const zip: ZipFile = new ZipFile(data);
const entries: ZipEntry[] = zip.listAllEntries();
entries.forEach((e: ZipEntry) => {
console.log(e.describe());
console.log(e.decompress());
});
List all entries in the ZIP file - listAllEntries(): ZipEntry[]
const zip: ZipFile = new ZipFile(data);
const entries: ZipEntry[] = zip.listAllEntries();
entries.forEach((e: ZipEntry) => {
console.log(e.describe());
});
Sample output
{ isDirectory: false, name: 'test.png', path: 'test.png' }
{ isDirectory: true, name: '__MACOSX', path: '__MACOSX/' }
{ isDirectory: false, name: '._test.png', path: '__MACOSX/._test.png' }
{ isDirectory: false, name: 'test.txt', path: 'test.txt' }
{ isDirectory: false, name: '._test.txt',path: '__MACOSX/._test.txt' }
Find an entry in the ZIP file - findEntries(string[]): ZipEntry[]
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['test.png'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach((e: ZipEntry) => {
console.log(e.describe());
});
Sample output
{ isDirectory: false, name: 'test.png', path: 'test.png' }
Find matching entries by RegExp - findMatchingEntries(reg: RegExp[]): ZipEntry[]
const zip: ZipFile = new ZipFile(data);
const regs: RegExp = [/^[a-z]+\.(png)/, /^[a-z]+\.(txt)/];
const entries: ZipEntry[] = zip.findMatchingEntries(regs);
entries.forEach((e: ZipEntry) => {
console.log(e.describe());
});
Sample output
{ isDirectory: false, name: 'test.png', path: 'test.png' }
{ isDirectory: false, name: 'test.txt', path: 'test.txt' }
Decompress file data - decompress(): Promise<Buffer>
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['test.png'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach(async (e: ZipEntry) => {
const info = e.describe();
const data = await e.decompress();
fs.writeFileSync(info.name, data); // IMPORTANT: Usage of sync method for demo purposes only
});
Sample output
Writes decompressed test.png under project root.
Getter for LocalFileHeader size - getLocalHeaderSize(): number
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['test.png'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach(async (e: ZipEntry) => {
console.log(e.getLocalHeaderSize());
});
Sample output
Prints LocalFileHeader size
Checks if the entry is a directory - isDirectory(): boolean
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['__MACOSX/'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach(async (e: ZipEntry) => {
console.log(e.isDirectory());
});
Sample output
ture // __MACOSX/' is a directory
Getter for entry name - getName(): string
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['test.png'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach(async (e: ZipEntry) => {
console.log(e.getName());
});
Sample output
Prints test.png
Getter for entry's full path in the zip file - getPath(): string
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['__MACOSX/._test.png'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach(async (e: ZipEntry) => {
console.log(e.getPath());
});
Sample output
Prints __MACOSX/._test.png
Describe entry in the zip file - describe(): IZipEntryDescription
const zip: ZipFile = new ZipFile(data);
const paths: string[] = ['test.png'];
const entries: ZipEntry[] = zip.findEntries(paths);
entries.forEach(async (e: ZipEntry) => {
console.log(e.describe());
});
Sample output
{ isDirectory: false, name: 'test.png', path: 'test.png' }
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent