Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

githubkit

package module

Go to main page

Versions in this module

v0

v0.3.2

Sep 24, 2026

v0.3.1

Sep 22, 2026

Changes in this version

+ func ResolveBaseURL(raw string) (*url.URL, error)

+ func StreamPages[T any](ctx context.Context, opts PaginationOptions, ...) error

type Option

+ func WithSecondaryPacing(d time.Duration) Option

type Options

+ SecondaryPacing time.Duration

v0.3.0

Sep 5, 2026

Changes in this version

type Option

+ func WithUserAgent(userAgent string) Option

type Options

+ UserAgent string

v0.2.0

Aug 16, 2026

Changes in this version

type ETagOptions

+ MaxBodyBytes int

v0.1.0

Aug 16, 2026

Changes in this version

+ const DefaultETagEntries

+ const DefaultRequestTimeout

+ const DefaultTokenEnvGH

+ const DefaultTokenEnvGITHUB

+ var DefaultRateLimitOptions = RateLimitOptions

+ var DefaultRetryOptions = RetryOptions

+ var ErrAPIUnavailable = errors.New("github: API unavailable")

+ var ErrAuthRequired = errors.New("github: authentication required")

+ var ErrForbidden = errors.New("github: forbidden")

+ var ErrInvalidPagination = errors.New("githubkit: PaginationOptions.MaxPages must be at least 1")

+ var ErrNotFound = errors.New("github: resource not found")

+ var ErrRateLimited = errors.New("github: rate limit exceeded")

+ func ClassifyError(err error) error

+ func FetchPages[T any](ctx context.Context, opts PaginationOptions, ...) ([]T, error)

+ type ETagCache struct

+ func NewETagCache(opts ETagOptions) *ETagCache

+ func (c *ETagCache) Stats() ETagStats

+ type ETagOptions struct

+ MaxEntries int

+ type ETagStats struct

+ Entries int

+ Hits int64

+ Stored int64

+ type Kernel struct

+ func New(opts ...Option) (*Kernel, error)

+ func (k *Kernel) ETagStats() (ETagStats, bool)

+ func (k *Kernel) RateLimitSnapshot() (RateLimitSnapshot, bool)

+ func (k *Kernel) RefreshRateLimit(ctx context.Context) (RateLimitSnapshot, error)

+ type Option func(*Options)

+ func WithAuthTokenFromEnv(vars ...string) Option

+ func WithBaseURL(rawURL string) Option

+ func WithETagCache(opts *ETagOptions) Option

+ func WithHTTPClient(client *http.Client) Option

+ func WithPAT(token string) Option

+ func WithRateLimitOptions(opts RateLimitOptions) Option

+ func WithRetryOptions(opts RetryOptions) Option

+ func WithTimeout(d time.Duration) Option

+ func WithoutRateLimit() Option

+ func WithoutRetry() Option

+ type Options struct

+ BaseURL string

+ ETag *ETagOptions

+ HTTPClient *http.Client

+ RateLimit RateLimitOptions

+ RequestTimeout time.Duration

+ Retry RetryOptions

+ Token string

+ TokenEnvVars []string

+ type PaginationOptions struct

+ Concurrency int

+ MaxPages int

+ OnProgress func(page, totalPages, cumulative int)

+ PerPage int

+ type RateLimitCache struct

+ func NewRateLimitCache() *RateLimitCache

+ func (c *RateLimitCache) Decrement(n int)

+ func (c *RateLimitCache) Get() (RateLimitSnapshot, bool)

+ func (c *RateLimitCache) Update(snapshot RateLimitSnapshot)

+ type RateLimitOptions struct

+ Enabled bool

+ MaxWait time.Duration

+ MinRemaining int

+ type RateLimitSnapshot struct

+ Limit int

+ Remaining int

+ ResetAt time.Time

+ func ParseRateLimitHeaders(header rateLimitHeaderSource) (RateLimitSnapshot, bool)

+ type RetryOptions struct

+ Enabled bool

+ InitialBackoff time.Duration

+ MaxBackoff time.Duration

+ MaxRetries int

+ type StatusError struct

+ Method string

+ Sentinel error

+ Status int

+ URL string

+ func (e *StatusError) Error() string

+ func (e *StatusError) Unwrap() []error