async-dl-github-repo v2.0.0

async-dl-github-repo

Asynchronously download a GitHub Repo

Why should you use this module instead of download-github-repo

This package has size in mind, while also being adapted to the latest Node.js versions. It is fully asyncronous, meaning you can download the repo, while doing other things. And, I've been inspired to make it because of download-github-repo

But heres a small list of what differs between async-dl-github-repo and download-github-repo:

• Size: async-dl-github-repo and its node_modules folder takes up around ~356KB, while download-github-repo and its node_modules takes up ~5.56MB
• Dependency Count: async-dl-github-repo has in total 6 dependencies (7, counting itself), while download-github-repo has 96! (including itself)

If dependency count, size, or asyncronous is what you need more, use this. If not, feel free to use download-github-repo

Installation

Node.js 8.0 or newer is required

To install this module, just run:

npm i async-dl-github-repo

Usage and Examples

This module has one function, that is exported by default.

download(repo, destination, downloadOnly = false)

Download a GitHub repo, repo should be in the format: Username/ProjectName[#branch-name], where #branch-name is optional. (Don't include the brackets). By default, the branch is set to master.

path should be relative to the process cwd

downloadOnly is optional, but you can make it just save the archive

Returns a Promise that resolves with the zip and final paths if the download was successful, or rejects if there were any errors.

Example:

const dlRepo = require("async-dl-github-repo");

dlRepo("KingDGrizzle/async-dl-github-repo", "./temp").then(results => {
	console.log(`Downloaded successfuly at ${results.finalPath}`);
}).catch(err => {
	console.error(`Download errored: ${err}`);
});

Downloading just the archive:

const dlRepo = require("async-dl-github-repo");

dlRepo("KingDGrizzle/async-dl-github-repo", "./temp", true).then(results => {
	console.log(`Downloaded at ${results.zipPath}`);
}).catch(err => {
	console.error(`Download errored: ${err}`);
});