Contribution

🗓 GitHub contribution streak & stat fetcher with zero dependencies

Install

npm install contribution

Usage

import { fetchStats } from 'contribution';

// Callbacks
fetchStats('jamieweavis', {
  onSuccess: gitHubStats => console.log(gitHubStats),
  onFailure: error => console.log(error),
});

// Promises
fetchStats('jamieweavis')
  .then(gitHubStats => console.log(gitHubStats))
  .catch(error => console.log(error));

// Async/await
try {
  const gitHubStats = await fetchStats('jamieweavis');
  console.log(gitHubStats);
} catch (error) {
  console.log(error);
}

interface GitHubStats {
  streak: {
    best: number;
    current: number;
    isAtRisk: boolean;
  };
  contributions: {
    best: number;
    total: number;
    current: number;
  };
}

Related

• Streaker - 🐙 GitHub contribution streak & stat tracking menu bar app
• Streaker CLI - 🐙 GitHub contribution streak & stat tracking CLI app