import GitHubConnector from 'hoist-connector-github/src/connector.js'

public class | source

GitHubConnector

Extends:

OAuth2ConnectorBase → GitHubConnector

A Hoist Connector for connecting to GitHub

Constructor Summary

Public Constructor
public	constructor(configuration: object) create a new connector

Method Summary

Public Methods
public	delete(path: ):
public	get(path: ):
public	patch(path: , body: ): *
public	post(path: , body: ): *

Public Constructors

public constructor(configuration: object) source

create a new connector

Params:

Name	Type	Attribute	Description
configuration	object		the configuration properties to use
configuration.clientId	string		the OAuth2 client id
configuration.clientSecret	string		the OAuth2 client secret
configuration.scope	string	optional default: 'user,repo,admin:repo_hook,notifications'	a comma separated list of scopes to use https://developer.github.com/v3/oauth/#scopes

Public Methods

public delete(path: ): source

Params:

Name	Type	Attribute	Description
path	*

Return:

public get(path: ): source

Params:

Name	Type	Attribute	Description
path	*

Return:

public patch(path: , body: ): * source

Params:

Name	Type	Attribute	Description
path	*
body	*

Return:

public post(path: , body: ): * source

Params:

Name	Type	Attribute	Description
path	*
body	*

GitHubConnector

Extends:

Constructor Summary

Method Summary

Public Constructors

public constructor(configuration: object) source

Params:

Public Methods

public delete(path: *): * source

Params:

Return:

public get(path: *): * source

Params:

Return:

public patch(path: *, body: *): * source

Params:

Return:

public post(path: *, body: *): * source

Params:

Return:

public delete(path: ): source

public get(path: ): source

public patch(path: , body: ): * source

public post(path: , body: ): * source