github-is-starred v1.0.1

github-is-starred

Checks if a user has starred a particular GitHub repo.

Install

npm install --save github-is-starred

Usage

const githubIsStarred = require('github-is-starred')

await githubIsStarred({
  username: 'blaise-hansen',
  repo: 'transitive-bullshit/create-react-library'
}) // => true

API

githubIsStarred

Checks if a user has starred a particular GitHub repo.

Type: function (opts): Promise

• opts object Config options
  • opts.username string GitHub username of user to check
  • opts.repo string Full name of GitHub repo to check
  • opts.client object? Optional authenticated @octokit/rest client

Related

• github-is-starred-cli - CLI for this module.
• @octokit/rest - GitHub REST API client for Node.js.

License

MIT © Travis Fischer