zip-lib 0.7.2 → 1.0.0

package/lib/cancelable.d.ts

@@ -1,38 +1,38 @@
-export interface ICancelable {
-    /**
-     * Cancel operation
-     */
-    cancel(): void;
-}
-export declare class CancellationToken {
-    private _isCancelled;
-    private _callbacks;
-    /**
-     * A flag signalling is cancellation has been requested.
-     */
-    get isCancelled(): boolean;
-    /**
-     * Subscribe a callback when cancellation is requested. The callback
-     * only ever fires `once` as cancellation can only happen once.
-     * @param cb A function will be called whent cancellation is requested.
-     * @returns A function that Unsubscribe the cancellation callback.
-     */
-    onCancelled(cb: () => void): () => void;
-    cancel(): void;
-}
-export declare abstract class Cancelable implements ICancelable {
-    abstract cancel(): void;
-    /**
-     * Ignore any other error if the `cancel` method has been called
-     *
-     * Error: EBADF: bad file descriptor, read
-     * EBADF error may occur when calling the cancel method.
-     * see https://travis-ci.org/fpsqdb/zip-lib/jobs/606040627#L124
-     * @param error
-     */
-    protected wrapError(error: Error, isCanceled: boolean): Error;
-    /**
-     * Returns an error that signals cancellation.
-     */
-    protected canceledError(): Error;
-}
+export interface ICancelable {
+    /**
+     * Cancel operation
+     */
+    cancel(): void;
+}
+export declare class CancellationToken {
+    private _isCancelled;
+    private _callbacks;
+    /**
+     * A flag signalling is cancellation has been requested.
+     */
+    get isCancelled(): boolean;
+    /**
+     * Subscribe a callback when cancellation is requested. The callback
+     * only ever fires `once` as cancellation can only happen once.
+     * @param cb A function will be called when cancellation is requested.
+     * @returns A function that Unsubscribe the cancellation callback.
+     */
+    onCancelled(cb: () => void): () => void;
+    cancel(): void;
+}
+export declare abstract class Cancelable implements ICancelable {
+    abstract cancel(): void;
+    /**
+     * Ignore any other error if the `cancel` method has been called
+     *
+     * Error: EBADF: bad file descriptor, read
+     * EBADF error may occur when calling the cancel method.
+     * see https://travis-ci.org/fpsqdb/zip-lib/jobs/606040627#L124
+     * @param error
+     */
+    protected wrapError(error: Error, isCanceled: boolean): Error;
+    /**
+     * Returns an error that signals cancellation.
+     */
+    protected canceledError(): Error;
+}

package/lib/cancelable.js

@@ -1,65 +1,65 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cancelable = exports.CancellationToken = void 0;
-class CancellationToken {
-    constructor() {
-        this._isCancelled = false;
-        this._callbacks = new Set();
-    }
-    /**
-     * A flag signalling is cancellation has been requested.
-     */
-    get isCancelled() {
-        return this._isCancelled;
-    }
-    /**
-     * Subscribe a callback when cancellation is requested. The callback
-     * only ever fires `once` as cancellation can only happen once.
-     * @param cb A function will be called whent cancellation is requested.
-     * @returns A function that Unsubscribe the cancellation callback.
-     */
-    onCancelled(cb) {
-        if (this.isCancelled) {
-            cb();
-            return () => {
-                // noop
-            };
-        }
-        this._callbacks.add(cb);
-        return () => this._callbacks.delete(cb);
-    }
-    cancel() {
-        if (this._isCancelled) {
-            return;
-        }
-        this._isCancelled = true;
-        this._callbacks.forEach((cb) => cb());
-        this._callbacks.clear();
-    }
-}
-exports.CancellationToken = CancellationToken;
-class Cancelable {
-    /**
-     * Ignore any other error if the `cancel` method has been called
-     *
-     * Error: EBADF: bad file descriptor, read
-     * EBADF error may occur when calling the cancel method.
-     * see https://travis-ci.org/fpsqdb/zip-lib/jobs/606040627#L124
-     * @param error
-     */
-    wrapError(error, isCanceled) {
-        if (isCanceled) {
-            return this.canceledError();
-        }
-        return error;
-    }
-    /**
-     * Returns an error that signals cancellation.
-     */
-    canceledError() {
-        const error = new Error("Canceled");
-        error.name = error.message;
-        return error;
-    }
-}
-exports.Cancelable = Cancelable;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cancelable = exports.CancellationToken = void 0;
+class CancellationToken {
+    constructor() {
+        this._isCancelled = false;
+        this._callbacks = new Set();
+    }
+    /**
+     * A flag signalling is cancellation has been requested.
+     */
+    get isCancelled() {
+        return this._isCancelled;
+    }
+    /**
+     * Subscribe a callback when cancellation is requested. The callback
+     * only ever fires `once` as cancellation can only happen once.
+     * @param cb A function will be called when cancellation is requested.
+     * @returns A function that Unsubscribe the cancellation callback.
+     */
+    onCancelled(cb) {
+        if (this.isCancelled) {
+            cb();
+            return () => {
+                // noop
+            };
+        }
+        this._callbacks.add(cb);
+        return () => this._callbacks.delete(cb);
+    }
+    cancel() {
+        if (this._isCancelled) {
+            return;
+        }
+        this._isCancelled = true;
+        this._callbacks.forEach((cb) => cb());
+        this._callbacks.clear();
+    }
+}
+exports.CancellationToken = CancellationToken;
+class Cancelable {
+    /**
+     * Ignore any other error if the `cancel` method has been called
+     *
+     * Error: EBADF: bad file descriptor, read
+     * EBADF error may occur when calling the cancel method.
+     * see https://travis-ci.org/fpsqdb/zip-lib/jobs/606040627#L124
+     * @param error
+     */
+    wrapError(error, isCanceled) {
+        if (isCanceled) {
+            return this.canceledError();
+        }
+        return error;
+    }
+    /**
+     * Returns an error that signals cancellation.
+     */
+    canceledError() {
+        const error = new Error("Canceled");
+        error.name = error.message;
+        return error;
+    }
+}
+exports.Cancelable = Cancelable;

package/lib/fs.js

@@ -1,175 +1,175 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRootPath = exports.rimraf = exports.pathExists = exports.ensureFolder = exports.getFileEntry = exports.readdirp = void 0;
-const path = require("path");
-const util = require("./util");
-async function readdirp(folder) {
-    const result = [];
-    const files = await util.readdir(folder);
-    for (const item of files) {
-        const file = path.join(folder, item);
-        const entry = await getFileEntry(file);
-        if (!entry.isSymbolicLink && entry.type === "dir") {
-            const subFiles = await readdirp(file);
-            if (subFiles.length > 0) {
-                result.push(...subFiles);
-                // If the folder is not empty, don't need to add the folder itself.
-                // continue and skip the code below
-                continue;
-            }
-        }
-        result.push(entry);
-    }
-    return result;
-}
-exports.readdirp = readdirp;
-async function getFileEntry(target) {
-    const stat = await util.lstat(target);
-    let isSymbolicLink = false;
-    let fileType = "file";
-    if (stat.isDirectory()) {
-        fileType = "dir";
-    }
-    else {
-        if (stat.isSymbolicLink()) {
-            isSymbolicLink = true;
-            // If the path is a link, we must instead use fs.stat() to find out if the
-            // link is a directory or not because lstat will always return the stat of
-            // the link which is always a file.
-            const actualStat = await util.stat(target);
-            if (actualStat.isDirectory()) {
-                fileType = "dir";
-            }
-        }
-    }
-    return {
-        path: target,
-        isSymbolicLink,
-        type: fileType,
-        mtime: stat.mtime,
-        mode: stat.mode
-    };
-}
-exports.getFileEntry = getFileEntry;
-async function ensureFolder(folder) {
-    // stop at root
-    if (folder === path.dirname(folder)) {
-        return Promise.resolve();
-    }
-    try {
-        await mkdir(folder);
-    }
-    catch (error) {
-        // ENOENT: a parent folder does not exist yet, continue
-        // to create the parent folder and then try again.
-        if (error.code === "ENOENT") {
-            await ensureFolder(path.dirname(folder));
-            return mkdir(folder);
-        }
-        // Any other error
-        return Promise.reject(error);
-    }
-}
-exports.ensureFolder = ensureFolder;
-async function pathExists(target) {
-    try {
-        await util.access(target);
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-exports.pathExists = pathExists;
-async function rimraf(target) {
-    if (isRootPath(target)) {
-        // refuse to recursively delete root
-        return Promise.reject(new Error(`Refuse to recursively delete root, path: "${target}"`));
-    }
-    try {
-        const stat = await util.lstat(target);
-        // Folder delete (recursive) - NOT for symbolic links though!
-        if (stat.isDirectory() && !stat.isSymbolicLink()) {
-            // Children
-            const children = await util.readdir(target);
-            await Promise.all(children.map(child => rimraf(path.join(target, child))));
-            // Folder
-            await util.rmdir(target);
-        }
-        // Single file delete
-        else {
-            // chmod as needed to allow for unlink
-            const mode = stat.mode;
-            if (!(mode & 128)) { // 128 === 0200
-                await util.chmod(target, mode | 128);
-            }
-            return util.unlink(target);
-        }
-    }
-    catch (error) {
-        if (error.code !== "ENOENT") {
-            throw error;
-        }
-    }
-}
-exports.rimraf = rimraf;
-async function mkdir(folder) {
-    try {
-        await util.mkdir(folder, 0o777);
-    }
-    catch (error) {
-        // ENOENT: a parent folder does not exist yet or folder name is invalid.
-        if (error.code === "ENOENT") {
-            return Promise.reject(error);
-        }
-        // Any other error: check if folder exists and
-        // return normally in that case if its a folder
-        try {
-            const fileStat = await util.stat(folder);
-            if (!fileStat.isDirectory()) {
-                return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
-            }
-        }
-        catch (statError) {
-            throw error; // rethrow original error
-        }
-    }
-}
-// "A"
-const charA = 65;
-// "Z"
-const charZ = 90;
-// "a"
-const chara = 97;
-// "z"
-const charz = 122;
-// ":"
-const charColon = 58;
-// "\"
-const charWinSep = 92;
-// "/"
-const cahrUnixSep = 47;
-function isDriveLetter(char0) {
-    return char0 >= charA && char0 <= charZ || char0 >= chara && char0 <= charz;
-}
-const winSep = "\\";
-const unixSep = "/";
-function isRootPath(target) {
-    if (!target) {
-        return false;
-    }
-    if (target === winSep ||
-        target === unixSep) {
-        return true;
-    }
-    if (process.platform === "win32") {
-        if (target.length > 3) {
-            return false;
-        }
-        return isDriveLetter(target.charCodeAt(0))
-            && target.charCodeAt(1) === charColon
-            && (target.length === 2 || target.charCodeAt(2) === charWinSep || target.charCodeAt(2) === cahrUnixSep);
-    }
-    return false;
-}
-exports.isRootPath = isRootPath;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRootPath = exports.rimraf = exports.pathExists = exports.ensureFolder = exports.getFileEntry = exports.readdirp = void 0;
+const path = require("path");
+const util = require("./util");
+async function readdirp(folder) {
+    const result = [];
+    const files = await util.readdir(folder);
+    for (const item of files) {
+        const file = path.join(folder, item);
+        const entry = await getFileEntry(file);
+        if (!entry.isSymbolicLink && entry.type === "dir") {
+            const subFiles = await readdirp(file);
+            if (subFiles.length > 0) {
+                result.push(...subFiles);
+                // If the folder is not empty, don't need to add the folder itself.
+                // continue and skip the code below
+                continue;
+            }
+        }
+        result.push(entry);
+    }
+    return result;
+}
+exports.readdirp = readdirp;
+async function getFileEntry(target) {
+    const stat = await util.lstat(target);
+    let isSymbolicLink = false;
+    let fileType = "file";
+    if (stat.isDirectory()) {
+        fileType = "dir";
+    }
+    else {
+        if (stat.isSymbolicLink()) {
+            isSymbolicLink = true;
+            // If the path is a link, we must instead use fs.stat() to find out if the
+            // link is a directory or not because lstat will always return the stat of
+            // the link which is always a file.
+            const actualStat = await util.stat(target);
+            if (actualStat.isDirectory()) {
+                fileType = "dir";
+            }
+        }
+    }
+    return {
+        path: target,
+        isSymbolicLink,
+        type: fileType,
+        mtime: stat.mtime,
+        mode: stat.mode
+    };
+}
+exports.getFileEntry = getFileEntry;
+async function ensureFolder(folder) {
+    // stop at root
+    if (folder === path.dirname(folder)) {
+        return Promise.resolve();
+    }
+    try {
+        await mkdir(folder);
+    }
+    catch (error) {
+        // ENOENT: a parent folder does not exist yet, continue
+        // to create the parent folder and then try again.
+        if (error.code === "ENOENT") {
+            await ensureFolder(path.dirname(folder));
+            return mkdir(folder);
+        }
+        // Any other error
+        return Promise.reject(error);
+    }
+}
+exports.ensureFolder = ensureFolder;
+async function pathExists(target) {
+    try {
+        await util.access(target);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.pathExists = pathExists;
+async function rimraf(target) {
+    if (isRootPath(target)) {
+        // refuse to recursively delete root
+        return Promise.reject(new Error(`Refuse to recursively delete root, path: "${target}"`));
+    }
+    try {
+        const stat = await util.lstat(target);
+        // Folder delete (recursive) - NOT for symbolic links though!
+        if (stat.isDirectory() && !stat.isSymbolicLink()) {
+            // Children
+            const children = await util.readdir(target);
+            await Promise.all(children.map(child => rimraf(path.join(target, child))));
+            // Folder
+            await util.rmdir(target);
+        }
+        // Single file delete
+        else {
+            // chmod as needed to allow for unlink
+            const mode = stat.mode;
+            if (!(mode & 128)) { // 128 === 0200
+                await util.chmod(target, mode | 128);
+            }
+            return util.unlink(target);
+        }
+    }
+    catch (error) {
+        if (error.code !== "ENOENT") {
+            throw error;
+        }
+    }
+}
+exports.rimraf = rimraf;
+async function mkdir(folder) {
+    try {
+        await util.mkdir(folder, 0o777);
+    }
+    catch (error) {
+        // ENOENT: a parent folder does not exist yet or folder name is invalid.
+        if (error.code === "ENOENT") {
+            return Promise.reject(error);
+        }
+        // Any other error: check if folder exists and
+        // return normally in that case if its a folder
+        try {
+            const fileStat = await util.stat(folder);
+            if (!fileStat.isDirectory()) {
+                return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
+            }
+        }
+        catch (statError) {
+            throw error; // rethrow original error
+        }
+    }
+}
+// "A"
+const charA = 65;
+// "Z"
+const charZ = 90;
+// "a"
+const chara = 97;
+// "z"
+const charz = 122;
+// ":"
+const charColon = 58;
+// "\"
+const charWinSep = 92;
+// "/"
+const cahrUnixSep = 47;
+function isDriveLetter(char0) {
+    return char0 >= charA && char0 <= charZ || char0 >= chara && char0 <= charz;
+}
+const winSep = "\\";
+const unixSep = "/";
+function isRootPath(target) {
+    if (!target) {
+        return false;
+    }
+    if (target === winSep ||
+        target === unixSep) {
+        return true;
+    }
+    if (process.platform === "win32") {
+        if (target.length > 3) {
+            return false;
+        }
+        return isDriveLetter(target.charCodeAt(0))
+            && target.charCodeAt(1) === charColon
+            && (target.length === 2 || target.charCodeAt(2) === charWinSep || target.charCodeAt(2) === cahrUnixSep);
+    }
+    return false;
+}
+exports.isRootPath = isRootPath;

package/lib/index.d.ts

@@ -1,25 +1,25 @@
-import { IZipOptions } from "./zip";
-import { IExtractOptions } from "./unzip";
-export * from "./zip";
-export * from "./unzip";
-/**
- * Compress a single file to zip.
- * @param file
- * @param zipFile the zip file path.
- * @param options
- */
-export declare function archiveFile(file: string, zipFile: string, options?: IZipOptions): Promise<void>;
-/**
- * Compress all the contents of the specified folder to zip.
- * @param folder
- * @param zipFile the zip file path.
- * @param options
- */
-export declare function archiveFolder(folder: string, zipFile: string, options?: IZipOptions): Promise<void>;
-/**
- * Extract the zip file to the specified location.
- * @param zipFile
- * @param targetFolder
- * @param options
- */
-export declare function extract(zipFile: string, targetFolder: string, options?: IExtractOptions): Promise<void>;
+import { IZipOptions } from "./zip";
+import { IExtractOptions } from "./unzip";
+export * from "./zip";
+export * from "./unzip";
+/**
+ * Compress a single file to zip.
+ * @param file
+ * @param zipFile the zip file path.
+ * @param options
+ */
+export declare function archiveFile(file: string, zipFile: string, options?: IZipOptions): Promise<void>;
+/**
+ * Compress all the contents of the specified folder to zip.
+ * @param folder
+ * @param zipFile the zip file path.
+ * @param options
+ */
+export declare function archiveFolder(folder: string, zipFile: string, options?: IZipOptions): Promise<void>;
+/**
+ * Extract the zip file to the specified location.
+ * @param zipFile
+ * @param targetFolder
+ * @param options
+ */
+export declare function extract(zipFile: string, targetFolder: string, options?: IExtractOptions): Promise<void>;