npm.io
1.1.2 • Published 3 years ago

gh-recent-activity

Licence
MIT
Version
1.1.2
Deps
1
Size
7 kB
Vulns
23
Weekly
0

Github Recent Activity

Get recent activity of a user on Github.

Working Demo

Link: https://react-hkd9sw.stackblitz.io/

demo

Installation

Using NPM
npm install gh-recent-activity
Usage
import { getUserActivity } from "gh-recent-activity";

const activity = await getUserActivity("akulsr0");
/*
[ 
  {
    text: 'Created main branch on akulsr0/gh-activity',
    user: {
      name: 'akulsr0',
      link: 'https://github.com/akulsr0',
      img: 'https://avatars.githubusercontent.com/u/43666833?'
    },
    repo: {
      name: 'akulsr0/gh-activity',
      link: 'https://github.com/akulsr0/gh-activity'
    },
    created: { type: 'branch', branch: 'main' },
    type: 'create'
  },
  ...
]
*/
Using Promise
import { getUserActivity } from "gh-recent-activity";

getUserActivity("akulsr0").then((activity) => {
  // Do what you want here...
  console.log(activity);
});
Options

You can also pass an additional options param in getUserActivity function.

Option Default Type Description
includeEmoji false Boolean Includes emoji in activity text
includeCommits false Boolean Includes user's commits activity

Keywords