Naively Programmable Module
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

gh-polyglot

2.3.3 • Public • Published

gh-polyglot

gh-polyglot

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

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.

<script src="path/to/gh.js"></script>
<script src="path/to/gh-polyglot.js"></script>

📋 Example

// Dependencies
var GhPolyglot = require("gh-polyglot");
 
// Stats about git-stats
var me = new GhPolyglot("IonicaBizau/git-stats");
 
// Repository stats
me.repoStats(function (err, stats) {
    console.log(err || stats);
});
 
// User stats
me.userStats(function (err, stats) {
    console.log(err || stats);
});

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. 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 and data 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 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—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

📜 License

MIT © Ionică Bizău

Install

npm i gh-polyglot

DownloadsWeekly Downloads

15

Version

2.3.3

License

MIT

Unpacked Size

116 kB

Total Files

6

Last publish

Collaborators

  • avatar