GitHub Contributors

Fetch all the contributors from a github repository, github organization, or github search

Usage

import {
    getContributorsFromRepo,
    getContributorsFromRepos,
    getContributorsFromOrgs,
    getContributorsFromSearch,
} from '@bevry/github-contributors'

getContributorsFromRepo('bevry/github-contributors')
    .then(console.log)
    .catch(console.error)
getContributorsFromRepos(['bevry/github-contributors'])
    .then(console.log)
    .catch(console.error)

// https://developer.github.com/v3/search/#search-repositories
getContributorsFromSearch('@bevry language:typescript', { pages: 0 })
    .then(console.log)
    .catch(console.error)
getContributorsFromOrgs(['bevry'], { pages: 0 })
    .then(console.log)
    .catch(console.error)

Install

npm

Install: npm install --save @bevry/github-contributors
Import: import * as pkg from ('@bevry/github-contributors')
Require: const pkg = require('@bevry/github-contributors')

Skypack

<script type="module">
    import * as pkg from '//cdn.skypack.dev/@bevry/github-contributors@^4.2.0'
</script>

unpkg

<script type="module">
    import * as pkg from '//unpkg.com/@bevry/github-contributors@^4.2.0'
</script>

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/@bevry/github-contributors@4.2.0'
</script>

Editions

This package is published with the following editions:

@bevry/github-contributors/source/index.ts is TypeScript source code with Import for modules
@bevry/github-contributors/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
@bevry/github-contributors aliases @bevry/github-contributors/edition-es2022/index.js
@bevry/github-contributors/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Require for modules
@bevry/github-contributors/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Import for modules