npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

github-calendar-json

v2.2.0

Published

Transform the GitHub contributions calendar into a JSON format.

Downloads

11

Readme

Github Calendar JSON

Transform the GitHub contributions calendar into a JSON format.

Installation

Using npm:

$ npm i github-calendar-json

Using yarn:

$ yarn add github-calendar-json

Documentation

githubContributions(username)

Params

  • String username: The GitHub username
  • Object fetchOptions: Options passed to fetch

Return

  • Object an object contain:
  • totalContributions (Number): The number of contributions in the last year.
  • lastContribution (Date): The date fo the last contribution.
  • days (Array): An array of day objects:
    • date (Date): The date of the day.
    • contributions (Number): The number of contributions.
    • level (Number): A number between 0 and 4, representing the level of the day.
  • weeks (Array): The day objects grouped by weeks.
  • calendar (Array): The day objects grouped as GitHub calendar.

Example

const { githubContributions } = require('github-calendar-json')

githubContributions('Unnunoctio')
  .then(data => {
    console.log(data)
  })
  .catch(err => {
    console.error(err)
  })

// Response:
// {
//    totalContributions: 280,
//    lastContribution: 2023-07-28T00:00:00.000Z,
//    days: [
//      {
//        date: 2022-04-24T00:00:00.000Z,
//        contributions: 2,
//        level: 1
//      },
//      ...
//      {
//        date: 2023-07-28T00:00:00.000Z,
//        contributions: 6,
//        level: 2
//      },
//    ],
//    weeks: [
//      [
//        <dayObject>, <dayObject>,
//        <dayObject>, <dayObject>,
//        <dayObject>, <dayObject>,
//        <dayObject>
//      ]
//    ],
//    calendar: [
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//      [ <dayObject>, <dayObject>, ... , <dayObject>, <dayObject> ],
//    ],
// }

License

MIT © Unnunoctio