@absolunet/git-archive 中文文档教程

Question

@absolunet/git-archive

git archive --remote wrapper

Install

$ npm install @absolunet/git-archive

Usage

const gitArchive = require('@absolunet/git-archive');

gitArchive.download('git@github.com:absolunet/node-git-archive.git').then((dir) => {
    console.log(dir);
});

API

download(url [, options])

返回一个 Promise 和下载存档的路径

url

必需
类型：字符串
由 git-archive#remote 指定的回购 url

options.treeish

类型：String
默认值：master
按照 git-archive#tree-ish< /a>

options.format

类型：字符串
默认值：zip
git-archive#format 指定的结果存档格式

options.extract

类型：<代码>布尔值
默认值：true
提取存档

options.path

类型：String
默认值：tmp
存档文件的路径和名称或提取的存档的路径。 如果未指定，将放在临时路径中。

License

麻省理工学院 © Absolunet