fetch-github-repositories

fetch-github-repositories

Fetch github repositories for a given user (or an organization).

Requirements

• Node.js v10 or higher

Why ?

• Fast and light.
• Replacement for repos which introduce dozen of dependencies just for a GET request...
• 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 fetchGithubRepositories = require("fetch-github-repositories");

async function main() {
    const options = { agent: "my-program" };
    const repos = await fetchGithubRepositories("userName", options);
    // Do the job with repos
}
main().catch(console.error);

API

fetchGithubRepositories(user: string, options?: Options): 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

License

MIT