kaven-utils
Version:
Utils for Node.js.
64 lines (63 loc) • 2.79 kB
TypeScript
/********************************************************************
* @author: Kaven
* @email: kaven@wuwenkai.com
* @website: http://blog.kaven.xyz
* @file: [Kaven-Utils] /src/KavenUtility.Archive.ts
* @create: 2020-07-29 13:57:23.481
* @modify: 2025-10-11 23:39:02.978
* @version: 6.0.5
* @times: 59
* @lines: 159
* @copyright: Copyright © 2020-2025 Kaven. All Rights Reserved.
* @description: [description]
* @license: [license]
********************************************************************/
import { TStringObject } from "kaven-basic";
import { IArchiveExtractOptions, IArchiveOptions, IExecuteOptions } from "./base/Interfaces.js";
/**
* @since 6.0.5
* @version 2025-10-11
*/
export declare function Build7zCommand(command: string, baseArchiveName: string, switches?: TStringObject<string | undefined>, ...args: string[]): string;
/**
* This function calls the 7z binary, it should be available in your PATH.
* @since 6.0.5
* @version 2025-10-11
*/
export declare function Invoke7zCommand(command: string, baseArchiveName: string, switches?: TStringObject<string | undefined>, args?: string[], options?: IExecuteOptions): Promise<number | null>;
/**
* This function calls the 7z binary, it should be available in your PATH.
* @since 5.3.0
* @version 2025-10-11
* @example
* CreateArchive("./dist/", "dist.7z")
* CreateArchive("./dist/*", "dist.7z")
*
* CreateArchive("./dist/", "dist.zip")
* CreateArchive("./dist/*", "dist.zip")
*/
export declare function CreateArchive(input: string | string[], outputFile: string, options?: IArchiveOptions, executeOptions?: IExecuteOptions): Promise<string>;
/**
* This function calls the 7z binary, it should be available in your PATH.
* @since 5.3.0
* @version 2025-10-11
* @example
* Create7zArchive("./dist/", "dist.7z")
* Create7zArchive("./dist/*", "dist.7z")
*/
export declare function Create7zArchive(inputFiles: string | string[], outputFile: string, options?: IArchiveOptions, executeOptions?: IExecuteOptions): Promise<string>;
/**
* This function calls the 7z binary, it should be available in your PATH.
* @since 5.3.0
* @version 2025-10-11
* @example
* CreateZipArchive("./dist/", "dist.zip")
* CreateZipArchive("./dist/*", "dist.zip")
*/
export declare function CreateZipArchive(inputFiles: string | string[], outputFile: string, options?: IArchiveOptions, executeOptions?: IExecuteOptions): Promise<string>;
/**
* This function calls the 7z binary, it should be available in your PATH.
* @since 6.0.5
* @version 2025-10-11
*/
export declare function ExtractArchive(archiveFile: string, options?: IArchiveExtractOptions, executeOptions?: IExecuteOptions): Promise<number | null>;