@shockpkg/core/lib/zip.d.ts

shockpkg core

import { ZipItter, ZipStreamer } from './types';
/**
 * Zip file reader class.
 */
export declare class Zip extends Object {
    /**
     * The zipfile instance, generic type to avoid dependency.
     */
    protected _zipfile: any;
    constructor();
    /**
     * Open with a file.
     *
     * @param file File path.
     */
    openFile(file: string): Promise<void>;
    /**
     * Open with a streamer.
     *
     * @param streamer Streamer function.
     * @param totalSize Total size of file.
     */
    openStreamer(streamer: ZipStreamer, totalSize: number): Promise<void>;
    /**
     * Read zip file entries.
     * To stop reading and close file, return false from itter.
     *
     * @param itter Callback function.
     */
    read(itter: ZipItter): Promise<void>;
}