/// <reference path="../../dts/_import/index.d.ts" />
/// <reference path="../interface/ZipFile.d.ts" />
/// <reference path="../interface/Buffer.d.ts" />
/// <reference path="../interface/SeekableStream.d.ts" />
/**
 * @description zip 格式文件压缩解压模块
 * 
 *  使用方法：
 *  ```JavaScript
 *  var zip = require('zip');
 *  ```
 *  
 */
declare module 'zip' {
    /**
     * @description 压缩类型常量, 不压缩, 仅存储 
     */
    export const ZIP_STORED: 0;

    /**
     * @description 压缩类型常量, 需要依赖zlib库进行压缩 
     */
    export const ZIP_DEFLATED: 1;

    /**
     * @description  判断文件是否是zip格式
     * 	 @param filename 文件名
     * 	 @return 返回true代表文件是zip文件
     * 	 
     */
    function isZipFile(filename: string): boolean;

    function isZipFile(filename: string, callback: (err: Error | undefined | null, retVal: boolean)=>any): void;

    /**
     * @description 打开一个zip文件
     * 	 @param path 文件路径
     * 	 @param mod 打开文件模式, "r"代表读取, "w"代表创建, "a"代表在zip文件后追加
     * 	 @param compress_type 压缩类型, ZIP_STORED 代表不压缩, 仅存储。 默认使用ZIP_DEFLATED 代表使用zlib库进行压缩。
     * 	 @return 返回zip文件对象
     * 	 
     */
    function open(path: string, mod?: string, compress_type?: number): Class_ZipFile;

    function open(path: string, mod?: string, compress_type?: number, callback?: (err: Error | undefined | null, retVal: Class_ZipFile)=>any): void;

    /**
     * @description 打开一个zip文件
     * 	 @param data zip文件数据
     * 	 @param mod 打开文件模式, "r"代表读取, "w"代表创建, "a"代表在zip文件后追加
     * 	 @param compress_type 压缩类型, ZIP_STORED 代表不压缩, 仅存储。 默认使用ZIP_DEFLATED 代表使用zlib库进行压缩。
     * 	 @return 返回zip文件对象
     * 	 
     */
    function open(data: Class_Buffer, mod?: string, compress_type?: number): Class_ZipFile;

    function open(data: Class_Buffer, mod?: string, compress_type?: number, callback?: (err: Error | undefined | null, retVal: Class_ZipFile)=>any): void;

    /**
     * @description 打开一个zip文件
     * 	 @param strm zip文件流
     * 	 @param mod 打开文件模式, "r"代表读取, "w"代表创建, "a"代表在zip文件后追加
     * 	 @param compress_type 压缩类型, ZIP_STORED 代表不压缩, 仅存储。 默认使用ZIP_DEFLATED 代表使用zlib库进行压缩。
     * 	 @return 返回zip文件对象
     * 	 
     */
    function open(strm: Class_SeekableStream, mod?: string, compress_type?: number): Class_ZipFile;

    function open(strm: Class_SeekableStream, mod?: string, compress_type?: number, callback?: (err: Error | undefined | null, retVal: Class_ZipFile)=>any): void;

}