@types/minizlib

Installation

npm install --save @types/minizlib

Summary

This package contains type definitions for minizlib (https://github.com/isaacs/minizlib).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/minizlib.

index.d.ts

/// <reference types="node" />

// Import from dependencies
import MiniPass = require("minipass");
import zlib = require("zlib");

// Exports only from typings
export { constants } from "zlib";

type BrotliMode = "BrotliCompress" | "BrotliDecompress";
type ZlibMode = "Gzip" | "Gunzip" | "Deflate" | "Inflate" | "DeflateRaw" | "InflateRaw" | "Unzip";

interface MiniPassOptions extends Omit<MiniPass.StringOptions, "encoding"> {
    encoding?: BufferEncoding | "buffer" | null;
}

interface ZlibBaseOptions extends MiniPassOptions {
    flush?: number | undefined;
    finishFlush?: number | undefined;
}

declare class ZlibBase extends MiniPass {
    readonly ended: boolean;
    constructor(opts: ZlibBaseOptions & zlib.BrotliOptions, mode: BrotliMode);
    constructor(opts: ZlibBaseOptions & zlib.ZlibOptions, mode: ZlibMode);

    close(): void;
    reset(): void;
    flush(flushFlag?: number): void;

    end(chunk: any, cb?: () => void): this;
    end(chunk?: any, encoding?: string | null, cb?: () => void): this;

    write(chunk: any, cb?: () => void): boolean;
    write(chunk?: any, encoding?: string | null, cb?: () => void): boolean;
}

interface ZlibOptions extends ZlibBaseOptions {
    level?: number | undefined;
    strategy?: number | undefined;
}

declare class Zlib extends ZlibBase {
    constructor(opts: ZlibOptions & zlib.ZlibOptions, mode: ZlibMode);

    params(level?: number, strategy?: number): void;
}

export class Deflate extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

export class Inflate extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

export class Gzip extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

export class Gunzip extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

export class DeflateRaw extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

export class InflateRaw extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

export class Unzip extends Zlib {
    constructor(opts: ZlibOptions & zlib.ZlibOptions);
}

declare class Brotli extends ZlibBase {
    constructor(opts: ZlibOptions & zlib.BrotliOptions, mode: BrotliMode);
}

export class BrotliCompress extends Brotli {
    constructor(opts: ZlibOptions & zlib.BrotliOptions);
}

export class BrotliDecompress extends Brotli {
    constructor(opts: ZlibOptions & zlib.BrotliOptions);
}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/node, minipass

Credits

These definitions were written by Sebastian Malton.