https://github.com/bevry-archive/github-contributors

Deprecated. Use https://github.com/bevry/github-api
https://github.com/bevry-archive/github-contributors

github-client github-contributors http-request nodejs

Last synced: 9 months ago
JSON representation

Deprecated. Use https://github.com/bevry/github-api

• Host: GitHub
• URL: https://github.com/bevry-archive/github-contributors
• Owner: bevry-archive
• License: other
• Created: 2013-03-14T00:39:29.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2023-12-30T16:30:23.000Z (almost 2 years ago)
• Last Synced: 2024-04-13T10:07:42.532Z (over 1 year ago)
• Topics: github-client, github-contributors, http-request, nodejs
• Language: TypeScript
• Homepage:
• Size: 586 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


GitHub Contributors


































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

## Usage

[Complete API Documentation.](http://master.github-contributors.bevry.surge.sh/docs/)

```javascript

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


``` html

    import * as pkg from '//cdn.skypack.dev/@bevry/github-contributors@^4.2.0'

```

unpkg


``` html

    import * as pkg from '//unpkg.com/@bevry/github-contributors@^4.2.0'

```

jspm


``` html

    import * as pkg from '//dev.jspm.io/@bevry/github-contributors@4.2.0'

```

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



History


Discover the release history by heading on over to the HISTORY.md file.

Contribute


Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers


Maintainers


These amazing people are maintaining this project:



Benjamin Lupton — view contributions



Sponsors


No sponsors yet! Will you be the first?

















Contributors


These amazing people have contributed code to this project:



Benjamin Lupton — view contributions



Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License


Unless stated otherwise all works are:

Copyright © 2013+ Bevry Pty Ltd



and licensed under:

Artistic License 2.0