https://github.com/deno-library/compress
compress and uncompress for Deno
https://github.com/deno-library/compress
deflate deno gzip tar tgz zip
Last synced: about 1 month ago
JSON representation
compress and uncompress for Deno
- Host: GitHub
- URL: https://github.com/deno-library/compress
- Owner: deno-library
- License: mit
- Created: 2020-07-05T11:27:32.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T03:48:17.000Z (about 2 months ago)
- Last Synced: 2025-04-03T00:06:29.670Z (about 2 months ago)
- Topics: deflate, deno, gzip, tar, tgz, zip
- Language: TypeScript
- Homepage:
- Size: 209 KB
- Stars: 40
- Watchers: 0
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# compress
[](https://jsr.io/@deno-library/compress)
[](https://deno.land/x/compress)
[](https://github.com/deno-library/compress/blob/main/LICENSE)
Utilities to compress and uncompress for Deno!
- [x] `tar`
- [x] `deflate`
- [x] `gzip`
- [x] `tgz`
- [x] `zip`
- [x] `brotli`
## Changelog
[changelog](./changelog.md)
# Usage
If you want to read and write files, you need the following [permissions](https://deno.land/manual/getting_started/permissions):
> --allow-read --allow-write
## `tar`
v0.5.5
Use `@std/tar` instead of `@std/archive` due to deprecation
If you want to use the old API, you can do it
> import { tar } from "jsr:@deno-library/compress/tar_archive/mod.ts";
### Definition
```ts
// JSR
import { tar } from "jsr:@deno-library/compress";
// or
// import { tar } from "jsr:@deno-library/[email protected]";
// or
// import { tar } from "https://deno.land/x/[email protected]/mod.ts";
// or only import tar
// import { tar } from "https://deno.land/x/[email protected]/tar/mod.ts";
export interface compressInterface {
excludeSrc?: boolean; // does not contain the src directory
debug?: boolean; // list the files and folders
}
export interface uncompressInterface {
debug?: boolean; // list the files and folders
}
tar.compress(src, dest, options?: compressInterface): Promise;
tar.uncompress(src, dest, options?: uncompressInterface): Promise;
```
### Example
```ts
// JSR
import { tar } from "jsr:@deno-library/compress";
// or
// import { tar } from "https://deno.land/x/[email protected]/mod.ts";
// compress folder
await tar.compress("./test", "./test.tar");
// compress folder, exclude src directory
await tar.compress("./test", "./test.tar", { excludeSrc: true });
// compress file
await tar.compress("./test.txt", "./test.tar");
// uncompress
await tar.uncompress("./test.tar", "./dest");
```
## `deflate`
This library contains a pure TypeScript implementation of
[deflate](https://en.wikipedia.org/wiki/Deflate), and you can
use deflate on its own:
```ts
// JSR
import {
deflate,
/** Compress data using deflate, and do not append a zlib header. */
deflateRaw,
inflate,
inflateRaw,
} from "jsr:@deno-library/compress";
// or
// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/[email protected]/mod.ts";
// or only import deflate, inflate, deflateRaw, inflateRaw
// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/[email protected]/zlib/mod.ts";
const str = "hello world!";
const bytes = new TextEncoder().encode(str);
// with zlib header
const compressed = deflate(bytes);
const decompressed = inflate(compressed);
// no zlib header
const compressed = deflateRaw(bytes);
const decompressed = inflateRaw(compressed);
```
## `gzip`
### Definition
```ts
interface GzipOptions {
level: number;
timestamp?: number;
name?: string;
}
gzip(bytes: Uint8Array, options?:GzipOptions): Uint8Array;
gunzip(bytes: Uint8Array): Uint8Array;
gzipFile(src: string, dest: string): Promise;
gunzipFile(src: string, dest: string): Promise;
class GzipStream {
compress(src: string, dest: string): Promise;
uncompress(src: string, dest: string): Promise;
on(event: "progress", listener: (percent: string) => void): this;
}
```
### Example
Let's compress and uncompress a file. (`gzip` only supports compressing
and decompressing a single file.)
**stream mode**\
Useful for reading and writing large files.
```ts
import { GzipStream } from "jsr:@deno-library/compress";
// or
// import { GzipStream } from "https://deno.land/x/[email protected]/mod.ts";
// or only import GzipStream
// import { GzipStream } from "https://deno.land/x/[email protected]/gzip/mod.ts";
const gzip = new GzipStream();
gzip.on("progress", (progress: string) => {
console.log(progress); // 0.00% => 100.00%
});
await gzip.compress("./big.mkv", "./big.mkv.gz");
await gzip.uncompress("./big.mkv.gz", "./big.mkv");
```
**no stream mode**\
(This is loading all data into memory, so we can't get a `progress` event.)
```ts
import { gunzipFile, gzipFile } from "jsr:@deno-library/compress";
// or
// import { gunzipFile, gzipFile } from "https://deno.land/x/[email protected]/mod.ts";
// or only import gzipFile, gunzipFile
// import { gzipFile, gunzipFile } from "https://deno.land/x/[email protected]/gzip/mod.ts";
await gzipFile("./deno.txt", "./deno.txt.gz");
await gunzipFile("./deno.txt.gz", "./deno.txt");
```
**`gzip` a string or a byte array**
> This is a pure TypeScript implementation, almost as fast as a Rust
> implementation.
```ts
import { gunzip, gzip } from "jsr:@deno-library/compress";
// or
// import { gunzip, gzip } from "https://deno.land/x/[email protected]/mod.ts";
// or only import gzip, gunzip
// import { gzip, gunzip } from "https://deno.land/x/[email protected]/zlib/mod.ts";
// gzip
const bytes = new TextEncoder().encode("hello");
const compressed = gzip(bytes);
// gunzip
const decompressed = gunzip(compressed);
```
## `tgz`
v0.5.5
Use `@std/tar` instead of `@std/archive` due to deprecation
If you want to use the old API, you can do it
> import { tgz } from "jsr:@deno-library/compress/tgz_archive/mod.ts";
### Definition
```ts
import { tgz } from "jsr:@deno-library/compress";
// or
// import { tgz } from "https://deno.land/x/[email protected]/mod.ts";
// or only import tgz
// import { tgz } from "https://deno.land/x/[email protected]/tgz/mod.ts";
export interface compressInterface {
excludeSrc?: boolean; // does not contain the src directory
debug?: boolean; // list the files and folders
}
export interface uncompressInterface {
debug?: boolean; // list the files and folders
}
tgz.compress(src, dest, options?: compressInterface): Promise;
tgz.uncompress(src, dest, options?: uncompressInterface): Promise;
```
### Example
```ts
import { tgz } from "jsr:@deno-library/compress";
// or
// import { tgz } from "https://deno.land/x/[email protected]/mod.ts";
// compress folder
await tgz.compress("./test", "./test.tar.gz");
// compress folder, exclude src directory
await tgz.compress("./test", "./test.tar.gz", { excludeSrc: true });
// compress file
await tgz.compress("./test.txt", "./test.tar.gz");
// uncompress
await tgz.uncompress("./test.tar.gz", "./dest");
```
## `zip`
### Definition
```ts
import { zip } from "jsr:@deno-library/compress";
// or
// import { zip } from "https://deno.land/x/[email protected]/mod.ts";
// or only import zip
// import { zip } from "https://deno.land/x/[email protected]/zip/mod.ts";
export interface compressInterface {
excludeSrc?: boolean; // does not contain the src directory
debug?: boolean; // list the files and folders
}
export interface uncompressInterface {
debug?: boolean; // list the files and folders
}
zip.compress(src, dest, options?: compressInterface): Promise;
zip.uncompress(src, dest, options?: uncompressInterface): Promise;
```
### Example
```ts
import { zip } from "jsr:@deno-library/compress";
// or
// import { zip } from "https://deno.land/x/[email protected]/mod.ts";
// compress folder
await zip.compress("./test", "./test.tar.gz");
// compress folder, exclude src directory
await zip.compress("./test", "./test.tar.gz", { excludeSrc: true });
// compress file
await zip.compress("./test.txt", "./test.tar.gz");
// uncompress
await zip.uncompress("./test.tar.gz", "./dest");
```
## `brotli`
### Example
```ts
import { brotli } from "jsr:@deno-library/compress";
const compressedBuffer = await brotli.compress(inputString);
//const compressedBuffer = brotli.compressSync(inputString);
// deno version >= v2.1.8 / 2025.01.30
// https://github.com/denoland/deno/pull/27815
const uncompressedBuffer = await brotli.uncompress(compressedBuffer);
// const uncompressedBuffer = brotli.uncompressSync(compressedBuffer);
```
[brotli example file](test/brotli.test.ts)
# test
```ts
deno test --allow-read --allow-write
```