client

Documentation

Index

• type Client
  • func New(repoOwner string, repoName string, accessToken string, cacheFile string) (Client, error)
  • func NewNonCachingClient(repoOwner string, repoName string, accessToken string) Client

Types

type Client

type Client interface {
	FetchCommitsToPathSince(string, time.Time) ([]commits.Commit, error)
	FetchCommitsWithCommentsToPathSince(string, time.Time) ([]commits.Commit, error)
	FetchIssuesSince(time.Time) ([]issues.Issue, error)
	FetchPullRequestsSince(time.Time) ([]prs.PullRequest, error)
	FetchPage(string) ([]byte, error)
	Done() error
}

A Client handles basic read only operations against the GitHub API

func New

func New(repoOwner string, repoName string, accessToken string, cacheFile string) (Client, error)

New returns a new github/client.Client that is ready for use callers can control the location of the internal cache file by specifing a non empty cacheFile pointing to the desired cache file which will be

created if it doesn't exist

func NewNonCachingClient

func NewNonCachingClient(repoOwner string, repoName string, accessToken string) Client

NewNonCachingClient returns a new github/client.Client that is ready for use but does not cache page responses. The client returned is not recommended for use with large repositories due to rate limiting