npm.io
2.0.0 • Published 5 years ago

github-streak-scraper

Licence
MIT
Version
2.0.0
Deps
2
Size
70 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

GitHub Streak Scraper

npm package Dependency Status

Parses the Contribution graph to count the current streak of a GitHub user.

Usage

Wrap githubStreakScraper('GitHub-user-name') in an async function/promise.

const getStreakData = async => {
  const githubStreak = await githubStreakScraper('theDavidBarton');
  console.log(githubStreak)
}
{
  user: 'theDavidBarton',
  currentlyOnStreak: true,
  currentStreakCount: 18,
  currentStreakStartDate: '2019-12-30'
}

License

MIT License

Copyright (c) 2020 David Barton