gh-polyglot
Get language stats about GitHub users and repositories.
☁️ Installation
# Using npm npm install --save gh-polyglot # Using yarn yarn add gh-polyglot
Using this library on the client side is possible as well, but it's dependent on gh.js
.
📋 Example
// Dependenciesvar GhPolyglot = ; // Stats about git-statsvar me = "IonicaBizau/git-stats"; // Repository statsme; // User statsme;
❓ Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. 🐛
- For direct and quick help, you can use Codementor. 🚀
📝 Documentation
GhPolyglot(input, token, host)
Creates a new instance of GhPolyglot
.
Params
- String
input
: The repository full name (e.g."IonicaBizau/gh-polyglot"
) or the username (e.g."IonicaBizau"
). - String
token
: An optional GitHub token used for making authenticated requests. - String
host
: An optional alternative Github FQDN (e.g."https://github.myenterprise.com/api/v3/"
)
Return
- GhPolyglot The
GhPolyglot
instance.
getAllRepos(callback)
Gets all user's repositories.
Params
- Function
callback
: The callback function.
Return
- Request The request object.
repoStats(callback)
Gets repository stats.
Params
- Function
callback
: The callback function.
Return
- Request The request object.
userStats(callback)
Gets user stats.
Params
- Function
callback
: The callback function.
Return
- Request The request object.
check(callback)
Wraps the callback in another function to manipulate the data.
Params
- Function
callback
: The callback function.
Return
- Function The wrapping function which gets the
err
anddata
arguments and changes the data converting it into an array.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💖 Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
-
Starring and sharing the projects you like 🚀
-
—I love books! I will remember you after years if you buy me one. 😁 📖
-
—You can make one-time donations via PayPal. I'll probably buy a
coffeetea. 🍵 -
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
-
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! ❤️
💫 Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
github-stats