github_config

Documentation

Index

• type Config
  • func New(options ...Option) *Config
• type Option
  • func WithArchiveBaseUrl(archiveBaseUrl *url.URL) Option
  • func WithBaseUrl(baseUrl *url.URL) Option
  • func WithFetchOptions(fetchOptions ...fetch_config.Option) Option
  • func WithToken(token string) Option

Types

type Config

type Config struct {
	// BaseUrl is where the API is reached. Defaults to GitHub's own.
	BaseUrl *url.URL
	// ArchiveBaseUrl is where commit archives are reached. It is separate
	// because they are served by the web host rather than the API.
	ArchiveBaseUrl *url.URL
	FetchOptions   []fetch_config.Option
}

func New

func New(options ...Option) *Config

type Option

type Option func(*Config)

func WithArchiveBaseUrl

func WithArchiveBaseUrl(archiveBaseUrl *url.URL) Option

func WithBaseUrl

func WithBaseUrl(baseUrl *url.URL) Option

func WithFetchOptions

func WithFetchOptions(fetchOptions ...fetch_config.Option) Option

func WithToken

func WithToken(token string) Option

WithToken authenticates requests, which raises the rate limit and is what reaching a private repository needs.