gh-recent-activity
TypeScript icon, indicating that this package has built-in type declarations

1.1.2 • Public • Published

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

Package Sidebar

Install

npm i gh-recent-activity

Weekly Downloads

2

Version

1.1.2

License

MIT

Unpacked Size

7.46 kB

Total Files

4

Last publish

Collaborators

  • akulsr0