Fetching Github Repo info with Node.js
A very simple node.js module for fetching information about a Github Repo. This was developed as a helper to a project of mine, and should probably be fixed up and made more robust.
Installing
Clone the repo
cd ~/my/node-project/git clone git://github.com/mikaelbr/node-repo-github.git
You'll now have a folder called node-repo-github/
in your node-project/
.
You could rename directory and or move it, if you'd like.
How to use
Firstly you need to require the module. Given the structure above this would be
var githubrepo = ;
Methods
Now you're ready to use it. As per now, this module only has one method; open. This finds a repo based on user and repo name.
githubrepo.open(username, repo, callback)
Parameters
- username – The username of the repo owner
- repo – Full repository name
- callback – Function to be invoked once there's data
Callback
The callback should look like this
{}
Where err
is the error notice and data
is the Github response.
Example
// Require module. Edit path to match your structurevar githubrepo = ; // Look for repo and set callback to log data foundgithubrepo;