github

README

GitHub

• https://docs.github.com/rest/reference/search
• https://github.com/octokit/auth-oauth-device.js/blob/main/test/index.test.ts

Rate limiting

The Search API has a custom rate limit. For requests using Basic Authentication, OAuth, or client ID and secret, you can make up to 30 requests per minute. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.

https://docs.github.com/en/rest/reference/search

Documentation

Index

• Constants
• Variables
• type Exchange
• type OAuth
  • func NewOAuth() (*OAuth, error)
  • func (o OAuth) Exchange() (*Exchange, error)
• type Repos
• type Search
  • func NewSearch(q string) Search
  • func (s Search) Page(value int)
  • func (s Search) PerPage(value int)
  • func (s Search) Repos(x *Exchange) (*Repos, error)

Constants

const HtmlOrigin = "https://github.com"

const Origin = "https://api.github.com"

Variables

var Verbose bool

Types

type Exchange

type Exchange struct {
	Access_Token string
	Error        string
}

type OAuth

type OAuth struct {
	Device_Code      string
	User_Code        string
	Verification_URI string
}

func NewOAuth

func NewOAuth() (*OAuth, error)

func (OAuth) Exchange

func (o OAuth) Exchange() (*Exchange, error)

type Repos

type Repos struct {
	Items []struct {
		HTML_URL         string
		Language         string
		Stargazers_Count int
	}
}

type Search

type Search struct {
	url.Values
}

func NewSearch

func NewSearch(q string) Search

func (Search) Page

func (s Search) Page(value int)

default 1

func (Search) PerPage

func (s Search) PerPage(value int)

default 30, max 100

func (Search) Repos

func (s Search) Repos(x *Exchange) (*Repos, error)

Set "x" to "nil" for no authentication.