github-rest

github-rest

GitHub API based on GitHub REST API v3.

Table of contents

• Get Started
• API
• Examples
• References

Links

• CHANGE LOG
• Homepage

Get Started

Class

const Rest = require('github-rest');
const rest = new Rest(/* token */ '<YOUR_PERSONAL_ACCESS_TOKEN>');
rest.createRepository({ name: '<REPO_NAME>'})
	.then(repo => { /* ... */ })
	.catch(err => { /* ... */ })

Standalone Function

const createRepository = require('github-rest/createRepository');

const options = {
	token: '<YOUR_PERSONAL_ACCESS_TOKEN>',
	name: '<REPO_NAME>',
	// ...
};

createRepository(options)
	.then(repo => { /* ... */ })
	.catch(err => { /* ... */ })
	;

API

• Class Rest(string token)
• Promise(Object) <rest>.createRepository(Object options)
• Promise(null) <rest>.deleteRepository(Object options)
• Promise(Object[]) <rest>.findRepositories(Object options)
• Promise(Object) <rest>.getRepository(Object options)
• Promise(Object) <rest>.whoami(Object options)

All methods are asynchronous and will return instances of Promise. Hereafter, response means what to be obtained in .then((response) => { /* ... */ }).

All methods may be required and invoked by itself as what we see in Get Started, Standalone Function.

createRepository

• options.token string
• options.orgname string OPTIONAL
• options.name string
• See GitHub REST API v3, Repositories, Create for more options.

Response metadata of the just created repository.

deleteRepository

• options.token string
• options.username string OPTIONAL
• options.name string

Delete repository one by once. If successfully executed (whether the repository deleted, or had been deleted before, or does not exist at all), null will be responsed. Otherwise, an error will be thrown and you should use .catch() to catch it.

findRepositories

• options.token string
• options.orgname string OPTIONAL
• options.username string OPTIONAL
• options.name string OPTIONAL

Response an array. Each item contains metadata of a matching repository.

• options.orgname and options.username SHOULD be fullname, while options.name is piece of name of target repositories.
• If options.name absent while options.username or options.orgname present, all repositories belong to the organization or user will be responsed.
• If options.name absent while both options.username and options.orgname present, the latter one will be ignored.
• ATTNETION: If there are too many repositoies matched, only the leading ones will be responsed.

getRepository

• options.token string
• options.username string OPTIONAL
• options.name string

Response metadata of the repository.

whoami

• options.token string

Response metadata of the user who is the owner of the token.

Examples

• createRepository
• deleteRepository
• findRepositories
• getRepository
• whoami

References

• GitHub REST API v3
• GraphQL API v4: Forming Calls with GraphQL
• Creating a personal access token for the command line