takin/lib/downloader/tar.d.ts

Front end engineering base toolchain and scaffold

import { Options as GotOptions } from 'got';
declare type TarInfo = GotOptions & {
    url: string;
    /**
     * 用于缩减解压后的文件路径
     * 默认为 1
     */
    strip?: number;
};
/**
 * 解析 tar 链接或选项
 * @param urlOrOptions - 链接或选项
 * @returns 解析后的 tar 链接或选项
 */
export declare function parseOptions(urlOrOptions: string | TarInfo): TarInfo;
/**
 * 判断是否支持处理当前链接
 * @param url - 链接
 * @returns 是否支持该链接
 */
export declare function supportProtocol(url: string): boolean;
/**
 * 基于 tar 压缩包选项获取名称
 * @param tarOptions - tar 压缩包选项
 * @returns 名称
 */
export declare function getName(tarOptions: TarInfo): string;
/**
 * 下载 tar 压缩包到指定目录
 * @param tarOptions - tar 压缩包选项
 * @param dest - 指定目录地址
 */
export declare function download(tarOptions: TarInfo, dest: string): Promise<void>;
export {};