search

deno-library / compress

compress and uncompress for Deno
MIT License
41 stars 6 forks source link
deflate deno gzip tar tgz zip

readme

compress

JSR Version deno.land/x/compress LICENSE

Utilities to compress and uncompress for Deno!

Changelog

changelog

Usage

If you want to read and write files, you need the following 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

// JSR
import { tar } from "jsr:@deno-library/compress";
// or
// import { tar } from "jsr:@deno-library/compress@0.5.5";
// or
// import { tar } from "https://deno.land/x/compress@v0.5.5/mod.ts";
// or only import tar
// import { tar } from "https://deno.land/x/compress@v0.5.5/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<void>;
tar.uncompress(src, dest, options?: uncompressInterface): Promise<void>;

Example

// JSR
import { tar } from "jsr:@deno-library/compress";
// or
// import { tar } from "https://deno.land/x/compress@v0.5.5/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, and you can use deflate on its own:

// 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/compress@v0.5.5/mod.ts";
// or only import deflate, inflate, deflateRaw, inflateRaw
// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/compress@v0.5.5/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

interface GzipOptions {
  level: number;
  timestamp?: number;
  name?: string;
}
gzip(bytes: Uint8Array, options?:GzipOptions): Uint8Array;
gunzip(bytes: Uint8Array): Uint8Array;
gzipFile(src: string, dest: string): Promise<void>;
gunzipFile(src: string, dest: string): Promise<void>;
class GzipStream {
  compress(src: string, dest: string): Promise<void>;
  uncompress(src: string, dest: string): Promise<void>;
  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.

import { GzipStream } from "jsr:@deno-library/compress";
// or
// import { GzipStream } from "https://deno.land/x/compress@v0.5.5/mod.ts";
// or only import GzipStream
// import { GzipStream } from "https://deno.land/x/compress@v0.5.5/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.)

import { gunzipFile, gzipFile } from "jsr:@deno-library/compress";
// or
// import { gunzipFile, gzipFile } from "https://deno.land/x/compress@v0.5.5/mod.ts";
// or only import gzipFile, gunzipFile
// import { gzipFile, gunzipFile } from "https://deno.land/x/compress@v0.5.5/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.

import { gunzip, gzip } from "jsr:@deno-library/compress";
// or
// import { gunzip, gzip } from "https://deno.land/x/compress@v0.5.5/mod.ts";
// or only import gzip, gunzip
// import { gzip, gunzip } from "https://deno.land/x/compress@v0.5.5/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

import { tgz } from "jsr:@deno-library/compress";
// or
// import { tgz } from "https://deno.land/x/compress@v0.5.5/mod.ts";
// or only import tgz
// import { tgz } from "https://deno.land/x/compress@v0.5.5/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<void>;
tgz.uncompress(src, dest, options?: uncompressInterface): Promise<void>;

Example

import { tgz } from "jsr:@deno-library/compress";
// or
// import { tgz } from "https://deno.land/x/compress@v0.5.5/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

import { zip } from "jsr:@deno-library/compress";
// or
// import { zip } from "https://deno.land/x/compress@v0.5.5/mod.ts";
// or only import zip
// import { zip } from "https://deno.land/x/compress@v0.5.5/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<void>;
zip.uncompress(src, dest, options?: uncompressInterface): Promise<void>;

Example

import { zip } from "jsr:@deno-library/compress";
// or
// import { zip } from "https://deno.land/x/compress@v0.5.5/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");

test

deno test --allow-read --allow-write