github-ratings v0.1.0

github-ratings

github-ratings is a module for both NodeJS and the Browser, which can be used to obtain various information about users and repositories.

Installation

This package is Typescript ready

npm i github-ratings

How to use it

Browser

To use it browser, you need to use the code from browser.js file.

<script src="path-to-local-library/browser.js"></script>

or via CDN

<script src="https://unpkg.com/github-ratings@X.Y.Z/browser.js"></script>

Where X.Y.Z represents the library version.

In this scenario, the library will be bound to the global window object with the property GithubRatings.

window.GithubRatings or simple GithubRatings can be used to access the library.

If you have a toolchain available you can use an import statement.

import GithubRatings from 'github-ratings/browser';

const GithubRatings = require('github-ratings/browser');

Node

The library is a default export.

For NodeJS environment, just replace browser with node.

import GithubRatings from 'github-ratings/node';

Because is a default export, here you can import it with what name you want.

Methods (1)

(1)

async fetchUserInfo(username: string, fields: UserField[]): Promise<PartialRecord<UserField, any>>  {}

This method will return information about a given user, based on the fields provided.

UserField can be one of the following:

• name - full name of the user
• bio
• avatar_url - profile pic URL
• company
• blog
• location,
• email,
• twitter_username,
• public_repos, - number of public repositories
• followers, - number of followers
• following, - the number of people being followed by the user
• created_at, - date at which the accout was created
• starts, - the number of total stars from the public repositories

Example

const res = await GithubRatings.fetchUserInfo('GeorgianStan', [
  'stars',
  'public_repos',
  'created_at',
]);

// res = { created_at: "2017-02-15T14:54:15Z", public_repos: 37, stars: 50}

Stay in touch

Author - Stan Georgian

Discussions - Discussions Page

License

This project is licensed under the MIT License