@types/uzip

Installation

npm install --save @types/uzip

Summary

This package contains type definitions for uzip (https://github.com/photopea/UZIP.js).

Details

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

index.d.ts

/**
 * Object with `key:property` pairs, where `key` is a file path, and `property` is an Uint8Array of its contents
 */
export interface UZIPFiles {
    [name: string]: Uint8Array;
}

/**
 * Object with information about file size
 */
export interface UZIPSizeInfo {
    [name: string]: { usize: number; csize: number };
}

/**
 * Set compression level (0-9)
 */
export interface UZIPOptions {
    level: number;
}

/**
 * Read a ZIP file (as `ArrayBuffer`) and convert into a key-value pair of containing files.
 * @param buf ArrayBuffer of the ZIP file
 * @param onlyNames If `true`, returns file sizes instead of contents.
 */
export function parse(buf: ArrayBuffer, onlyNames?: boolean): UZIPFiles;
export function parse(buf: ArrayBuffer, onlyNames: true): UZIPSizeInfo;

/**
 * Encode files into a ZIP buffer
 * @param obj Object with `key:property` pairs, where `key` is a file path, and `property` is an Uint8Array of its contents
 * @param noCmpr Disable ZIP compression
 */
export function encode(obj: UZIPFiles, noCmpr?: boolean): ArrayBuffer;

/**
 * Compress buffer. Returns an `Uint8Array` of DEFLATE stream
 * @param data Buffer to be compressed
 * @param options Optional object specifying level of compression
 */
export function deflateRaw(data: Uint8Array, options?: UZIPOptions): Uint8Array;

/**
 * Compress buffer. Returns an `Uint8Array` of ZLIB stream (2 byte header + DEFLATE stream + 4 byte checksum)
 * @param data Buffer to be compressed
 * @param options Optional object specifying level of compression
 */
export function deflate(data: Uint8Array, options?: UZIPOptions): Uint8Array;

/**
 * Decompress buffer. Returns Uint8Array with decompressed bytes
 * @param file Buffer containing a ZLIB stream _(2 byte header + DEFLATE stream + 4 byte checksum)_ to be decompressed.
 * @param outputBuffer Optional additional buffer.
 * More details at https://github.com/photopea/uzip.js
 */
export function inflate(file: Uint8Array, outputBuffer?: Uint8Array): Uint8Array;

/**
 * Decompress buffer. Returns Uint8Array with decompressed bytes
 * @param file Buffer to be decompressed, containing a Deflate stream
 * @param outputBuffer Optional additional buffer.
 * More details at https://github.com/photopea/uzip.js
 */
export function inflateRaw(file: Uint8Array, outputBuffer?: Uint8Array): Uint8Array;

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by lucaspontoexe.