github

Documentation

Index

• Variables
• type Contents
• type GitHub
  • func New(owner, repo, reference, token string) (*GitHub, error)
  • func (gh *GitHub) APICallCount() uint64
  • func (gh *GitHub) Get(ctx context.Context, path string) ([]byte, error)
  • func (gh *GitHub) Join(elem ...string) string
  • func (gh *GitHub) ReadDir(ctx context.Context, path string) ([]string, error)
  • func (gh *GitHub) Stat(ctx context.Context, path string) (*fs.FileInfo, error)

Variables

var ErrAPI = errors.New("failed to communicate with the GitHub API")

Types

type Contents

type Contents struct {
	File      *github.RepositoryContent
	Directory []*github.RepositoryContent
}

type GitHub

type GitHub struct {
	// contains filtered or unexported fields
}

func New

func New(owner, repo, reference, token string) (*GitHub, error)

func (*GitHub) APICallCount

func (gh *GitHub) APICallCount() uint64

func (*GitHub) Get

func (gh *GitHub) Get(ctx context.Context, path string) ([]byte, error)

func (*GitHub) Join

func (gh *GitHub) Join(elem ...string) string

func (*GitHub) ReadDir

func (gh *GitHub) ReadDir(ctx context.Context, path string) ([]string, error)

func (*GitHub) Stat

func (gh *GitHub) Stat(ctx context.Context, path string) (*fs.FileInfo, error)