@e-mc/compress

  • npm i @e-mc/compress

Interface

View Source
import type { CompressLevel } from "./squared";

import type { IModule, ModuleConstructor } from "./index";
import type { BufferResult, CompressFormat, TryFileCompressor } from "./compress";
import type { CompressModule, CompressSettings } from "./settings";

import type { WriteStream } from "fs";
import type { Readable } from "stream";
import type { BrotliCompress, Gzip } from "zlib";

interface ICompress extends IModule {
    module: CompressModule;
    level: Record<string, number>;
    compressors: Record<string, TryFileCompressor>;
    init(...args: unknown[]): this;
    register(format: string, callback: TryFileCompressor): void;
    getLevel(value: string, fallback?: number): number | undefined;
    getReadable(file: string | URL | Buffer): Readable;
    createGzip(file: string | Buffer, options?: CompressLevel): Gzip;
    createBrotliCompress(file: string | Buffer, options?: CompressLevel): BrotliCompress;
    createWriteStreamAsGzip(file: string | Buffer, output: string, options?: CompressLevel): WriteStream;
    createWriteStreamAsBrotli(file: string | Buffer, output: string, options?: CompressLevel): WriteStream;
    writeGzip(file: string | Buffer, output: string, options?: CompressLevel): Promise<void>;
    writeBrotli(file: string | Buffer, output: string, options?: CompressLevel): Promise<void>;
    tryFile(file: string | Buffer, options: CompressFormat): Promise<BufferResult>;
    tryFile(file: string | Buffer, output: string, options?: CompressFormat): Promise<BufferResult>;
    tryImage(file: string, options: CompressFormat): Promise<BufferResult>;
    tryImage(file: string | Buffer, output: string, options?: CompressFormat): Promise<BufferResult>;
    set chunkSize(value: number | string | undefined): void;
    get chunkSize(): number | undefined;
    get settings(): CompressSettings;
}

interface CompressConstructor extends ModuleConstructor {
    singleton(): ICompress;
    readonly prototype: ICompress;
    new(module?: CompressModule): ICompress;
}

Added in version 0.10.0:

  • ICompress property chunkSize was converted into a 1KB aligned accessor.

Added in version 0.9.0:

  • ICompress methods writeGzip | writeBrotli were created.

Removed in version 0.9.0:

  • ICompress methods tryFile | tryImage optional argument callback as function.

Settings

View JSON
import type { BrotliOptions, ZlibOptions } from "zlib";
import type { Options as ZopfliOptions } from "node-zopfli";

interface CompressModule {
    gzip?: ZlibOptions;
    brotli?: BrotliOptions;
    zopfli?: ZopfliOptions;
    tinify?: {
        api_key?: string;
        proxy?: string;
    };
    settings?: {
        broadcast_id?: string | string[];
        cache?: boolean;
        cache_expires?: number | string;
        gzip_level?: number;
        brotli_quality?: number;
        zopfli_iterations?: number;
        chunk_size?: number | string;
    };
}

Example usage

const Compress = require("@e-mc/compress");

const instance = new Compress({
  gzip: {
    memLevel: 1,
    windowBits: 16
  },
  tinify: {
    api_key: "**********"
  },
  settings: {
    gzip_level: 9, // Lowest priority
    brotli_quality: 11,
    chunk_size: "16kb" // All compression types
  }
});
instance.init();

const stream = instance.createWriteStreamAsGzip("/tmp/archive.tar", "/path/output/archive.tar.gz", { level: 5, chunkSize: 4 * 1024 }); // Override settings
stream
  .on("finish", () => console.log("finish"))
  .on("error", err => console.error(err));

const options = {
  plugin: "tinify",
  format: "png", // Optional with extension
  timeout: 60 * 1000, // 1m
  options: {
    apiKey: "**********" // Override settings
  }
};
instance.tryImage("/tmp/image.png", "/path/output/compressed.png", options)
  .then(data => {
    console.log(Buffer.byteLength(data));
  })
  .catch(err => console.error(err));

References