Gh-star-fetch NPM

gh-star-fetch

About The Project

Fetch all the starred repositories for a GitHub user

This packages helps in retrieving all the starred repositories for a given github user. This was usefull to me before moving to graphql gh api, I'm leaving this here just for easier usage.

Installation

npm i --save gh-star-fetch
# OR
yarn add gh-star-fetch

Usage

const results = await ghStarFetch({
  accessToken: '<GITHUB_PERSONAL_ACCESS_TOKEN>',
});

Options

name	type	default	description
`accessToken`	`String`		This is you github PAT
`username`	`String`		Default to the username of the accessToken, if changed scrapes another user's stars
`compactByLanguage`	`Bool`	`false`	Instead of a single array, output will be compacted by languages
`http`	`http.Client`	`Got`	This is the HTTP client used to fetch data
`transform`	`(star: Star) => Partial<Star>`		You can transform each star object before its pushed to the output array with this callback