zip-lib 0.7.3 → 1.0.0

package/lib/index.js

@@ -1,56 +1,56 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extract = exports.archiveFolder = exports.archiveFile = void 0;
-const zip_1 = require("./zip");
-const unzip_1 = require("./unzip");
-__exportStar(require("./zip"), exports);
-__exportStar(require("./unzip"), exports);
-/**
- * Compress a single file to zip.
- * @param file
- * @param zipFile the zip file path.
- * @param options
- */
-function archiveFile(file, zipFile, options) {
-    const zip = new zip_1.Zip(options);
-    zip.addFile(file);
-    return zip.archive(zipFile);
-}
-exports.archiveFile = archiveFile;
-/**
- * Compress all the contents of the specified folder to zip.
- * @param folder
- * @param zipFile the zip file path.
- * @param options
- */
-function archiveFolder(folder, zipFile, options) {
-    const zip = new zip_1.Zip(options);
-    zip.addFolder(folder);
-    return zip.archive(zipFile);
-}
-exports.archiveFolder = archiveFolder;
-/**
- * Extract the zip file to the specified location.
- * @param zipFile
- * @param targetFolder
- * @param options
- */
-function extract(zipFile, targetFolder, options) {
-    const unzip = new unzip_1.Unzip(options);
-    return unzip.extract(zipFile, targetFolder);
-}
-exports.extract = extract;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extract = exports.archiveFolder = exports.archiveFile = void 0;
+const zip_1 = require("./zip");
+const unzip_1 = require("./unzip");
+__exportStar(require("./zip"), exports);
+__exportStar(require("./unzip"), exports);
+/**
+ * Compress a single file to zip.
+ * @param file
+ * @param zipFile the zip file path.
+ * @param options
+ */
+function archiveFile(file, zipFile, options) {
+    const zip = new zip_1.Zip(options);
+    zip.addFile(file);
+    return zip.archive(zipFile);
+}
+exports.archiveFile = archiveFile;
+/**
+ * Compress all the contents of the specified folder to zip.
+ * @param folder
+ * @param zipFile the zip file path.
+ * @param options
+ */
+function archiveFolder(folder, zipFile, options) {
+    const zip = new zip_1.Zip(options);
+    zip.addFolder(folder);
+    return zip.archive(zipFile);
+}
+exports.archiveFolder = archiveFolder;
+/**
+ * Extract the zip file to the specified location.
+ * @param zipFile
+ * @param targetFolder
+ * @param options
+ */
+function extract(zipFile, targetFolder, options) {
+    const unzip = new unzip_1.Unzip(options);
+    return unzip.extract(zipFile, targetFolder);
+}
+exports.extract = extract;

package/lib/unzip.d.ts

@@ -1,78 +1,78 @@
-import { Cancelable } from "./cancelable";
-export interface IExtractOptions {
-    /**
-     * If it is `true`, the target directory will be deleted before extract.
-     * The default value is `false`.
-     */
-    overwrite?: boolean;
-    /**
-     * Extract symbolic links as files on Windows. This value is only available on Windows and ignored on other platforms.
-     * The default value is `true`.
-     *
-     * If `true`, the symlink in the zip will be extracted as a normal file on Windows.
-     *
-     * If `false`, the symlink in the zip will be extracted as a symlink correctly on Windows, but an `EPERM` error will be thrown under non-administrators.
-     *
-     * > ⚠**WARNING:** On Windows, the default security policy allows only administrators to create symbolic links.
-     * If you set `symlinkAsFileOnWindows` to `false` and the zip contains symlink,
-     * be sure to run the code under the administrator, otherwise an `EPERM` error will be thrown.
-     */
-    symlinkAsFileOnWindows?: boolean;
-    /**
-     * Called before an item is extracted.
-     * @param event
-     */
-    onEntry?: (event: IEntryEvent) => void;
-}
-/**
- * The IEntryEvent interface represents an event that an entry is about to be extracted.
- */
-export interface IEntryEvent {
-    /**
-     * Entry name.
-     */
-    readonly entryName: string;
-    /**
-     * Total number of entries.
-     */
-    readonly entryCount: number;
-    /**
-     * Prevent extracting current entry.
-     */
-    preventDefault(): void;
-}
-/**
- * Extract the zip file.
- */
-export declare class Unzip extends Cancelable {
-    private options?;
-    /**
-     *
-     */
-    constructor(options?: IExtractOptions | undefined);
-    private zipFile;
-    private token;
-    /**
-     * Extract the zip file to the specified location.
-     * @param zipFile
-     * @param targetFolder
-     * @param options
-     */
-    extract(zipFile: string, targetFolder: string): Promise<void>;
-    /**
-     * Cancel decompression.
-     * If the cancel method is called after the extract is complete, nothing will happen.
-     */
-    cancel(): void;
-    private closeZip;
-    private openZip;
-    private handleEntry;
-    private openZipFileStream;
-    private extractEntry;
-    private writeEntryToFile;
-    private modeFromEntry;
-    private createSymlink;
-    private isOverwrite;
-    private onEntryCallback;
-    private symlinkToFile;
-}
+import { Cancelable } from "./cancelable";
+export interface IExtractOptions {
+    /**
+     * If it is `true`, the target directory will be deleted before extract.
+     * The default value is `false`.
+     */
+    overwrite?: boolean;
+    /**
+     * Extract symbolic links as files on Windows. This value is only available on Windows and ignored on other platforms.
+     * The default value is `true`.
+     *
+     * If `true`, the symlink in the zip will be extracted as a normal file on Windows.
+     *
+     * If `false`, the symlink in the zip will be extracted as a symlink correctly on Windows, but an `EPERM` error will be thrown under non-administrators.
+     *
+     * > ⚠**WARNING:** On Windows, the default security policy allows only administrators to create symbolic links.
+     * If you set `symlinkAsFileOnWindows` to `false` and the zip contains symlink,
+     * be sure to run the code under the administrator, otherwise an `EPERM` error will be thrown.
+     */
+    symlinkAsFileOnWindows?: boolean;
+    /**
+     * Called before an item is extracted.
+     * @param event
+     */
+    onEntry?: (event: IEntryEvent) => void;
+}
+/**
+ * The IEntryEvent interface represents an event that an entry is about to be extracted.
+ */
+export interface IEntryEvent {
+    /**
+     * Entry name.
+     */
+    readonly entryName: string;
+    /**
+     * Total number of entries.
+     */
+    readonly entryCount: number;
+    /**
+     * Prevent extracting current entry.
+     */
+    preventDefault(): void;
+}
+/**
+ * Extract the zip file.
+ */
+export declare class Unzip extends Cancelable {
+    private options?;
+    /**
+     *
+     */
+    constructor(options?: IExtractOptions | undefined);
+    private zipFile;
+    private token;
+    /**
+     * Extract the zip file to the specified location.
+     * @param zipFile
+     * @param targetFolder
+     * @param options
+     */
+    extract(zipFile: string, targetFolder: string): Promise<void>;
+    /**
+     * Cancel decompression.
+     * If the cancel method is called after the extract is complete, nothing will happen.
+     */
+    cancel(): void;
+    private closeZip;
+    private openZip;
+    private handleEntry;
+    private openZipFileStream;
+    private extractEntry;
+    private writeEntryToFile;
+    private modeFromEntry;
+    private createSymlink;
+    private isOverwrite;
+    private onEntryCallback;
+    private symlinkToFile;
+}