2.0.0 • Published 5 years ago
fetch-github-repositories v2.0.0
fetch-github-repositories
Fetch github repositories for a given user (or an organization).
Requirements
- Node.js v10 or higher
Why ?
- Fast and light (With a lazy API if required).
- Support both
users
andorgs
endpoints with the kind option. - Replacement for repos which introduce dozen of dependencies.
- Come with a bundled TypeScript definition for intellisense.
Getting Started
This package is available in the Node Package Repository and can be easily installed with npm or yarn.
$ npm i fetch-github-repositories
# or
$ yarn add fetch-github-repositories
Usage example
const { fetch, fetchLazy } = require("fetch-github-repositories");
async function main() {
const repos = await fetch("fraxken", {
fetchUserOrgs: true // if you want an equivalent of "repos"
});
// or use lazy API
for await (const repo of fetchLazy("fraxken")) {
console.log(repo.full_name);
}
}
main().catch(console.error);
API
fetch(user: string, options?: Options): Promise< Repository[] >
Return an Array of repositories (the interface can be found in index.d.ts).
Options:
name | default value | description |
---|---|---|
agent | "fetch-github-repo" | User-Agent header (required by github) |
token | undefined | github token for private repositories |
kind | "users" | can be either users or orgs |
fetchUserOrgs | fetch users organizations repositories when the kind is equal to users |
fetchLazy(user: string, options?: Options): AsyncIterableIterator< Repository >
Same arguments as fetch.
License
MIT