Home Reference Source Test Repository
import Github from 'github-extended'
public class | source

Github

Extends:

* → Github

The class that extends Github.js

Test:

Constructor Summary

Public Constructor
public

constructor(options: Object)

Member Summary

Public Members
public

getRepo(user: string, repo: string): Object: *

Returns an object representing a specific repository

Public Constructors

public constructor(options: Object) source

Params:

NameTypeAttributeDescription
options Object

The object containing the information to work with the GitHub API

options.username string

The username used on GitHub

options.password string

The password of the GitHub account

options.auth string

The type of authentication to use. It can be either basic or oauth

options.token string

The token to access the GitHub API

Public Members

public getRepo(user: string, repo: string): Object: * source

Returns an object representing a specific repository

Return:

Object