UNPKG

@terascope/fetch-github-release

Version:

Download a specific release from github

15 lines 1.05 kB
import { GithubRelease, GithubReleaseAsset, ReleaseInfo } from './interfaces'; /** * Download a specific github release * @param user The name of the github user or organization * @param repo The name of the github repository * @param outputDir The directory to write the release to * @param filterRelease Optionally filter the release * @param filterAsset Optionally filter the asset for a given release * @param leaveZipped Optionally leave the file zipped * @param leaveZipped Optionally disable logging for quiet output * @param dryRun Only return information on what would have been downloaded * @param output Returns dry-run information in either plaintext or json format */ export declare function downloadRelease(user: string, repo: string, outputDir: string, filterRelease?: (release: GithubRelease) => boolean, filterAsset?: (release: GithubReleaseAsset) => boolean, leaveZipped?: boolean, disableLogging?: boolean, dryRun?: boolean, output?: string): Promise<string[] | ReleaseInfo>; //# sourceMappingURL=downloadRelease.d.ts.map