Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GitHub

Hierarchy

  • GitHub

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new GitHub(owner: string, name: string): GitHub

Properties

_api

_api: GitHubApi

Private authed

authed: boolean = false

name

name: string

owner

owner: string

Accessors

api

  • get api(): GitHubApi

url

  • get url(): string

Methods

createAuthorization

  • createAuthorization(params: AuthorizationCreateParams): Promise<AuthResponse>

createKey

  • createKey(key: string): Promise<any>

deleteAuthorization

  • deleteAuthorization(id: string | number): Promise<any>

deleteKey

  • deleteKey(id: string | number): Promise<any>

fetchTags

  • fetchTags(): Promise<Tag[]>

findAuthorization

  • findAuthorization(params: AuthorizationCreateParams): Promise<AuthResponse>

  • Find an authorization that matches the supplied params. NOTE: the token value will be unavailable and is only available on creation

    Parameters

    • params: AuthorizationCreateParams

      search params to match for the authorization

    Returns Promise<AuthResponse>

getHttpsUrl

  • getHttpsUrl(): string

getSshUrl

  • getSshUrl(): string

isApiAuthenticated

  • isApiAuthenticated(): boolean

  • Report if the API has been authenticated with an OAuth token. API calls that have not been authenticated are subject to stricter rate-limits

    Returns boolean

    if the API has an OAuth token

toString

  • toString(): string

Generated using TypeDoc