takin/lib/downloader/npm.d.ts

Front end engineering base toolchain and scaffold

interface NpmInfo {
    name: string;
    version?: string;
    registry?: string;
}
/**
 * 设置自定义 npm registry 地址
 * @param url - 自定义 npm registry 地址
 */
export declare function setRegistryUrl(url: string): void;
/**
 * 解析 npm 链接或选项
 * @param urlOrOptions npm 链接或选项
 * @returns npm 选项
 */
export declare function parseOptions(urlOrOptions: string | NpmInfo): NpmInfo;
/**
 * 判断是否支持处理当前链接
 * @param url - 链接
 * @returns 是否支持该链接
 */
export declare function supportProtocol(url: string): boolean;
/**
 * 从 npm 选项中获取名称
 * @param options - npm 选项
 * @returns 名称
 */
export declare function getName(npmOptions: NpmInfo): string;
/**
 * 下载 npm 到指定的目录
 * @param npmOptions - npm 下载链接或选项
 * @param dest - 下载目录
 * @returns 下载并解压后的目录
 */
export declare function download(npmOptions: NpmInfo, dest: string): Promise<void>;
export {};