doc

Jun 27, 2024

Changes in this version

type SearchOption

+ func WithDuplicateTypeFuncs() SearchOption

May 28, 2024

Changes in this version

type Package

+ ConstantMap map[string]Variable

+ VariableMap map[string]Variable

May 27, 2024

Changes in this version

type CachedSearcher

+ func NewCachedSearcher(parser Parser, opts ...SearchOption) CachedSearcher

type Package

+ Constants map[string]Variable

+ Variables map[string]Variable

+ type SearchOption = func(s *httpSearcher)

+ func WithClient(client *http.Client) SearchOption

type Searcher

+ func NewSearcher(parser Parser, opts ...SearchOption) Searcher

+ type Variable struct

+ Comment Comment

+ Name string

+ Signature string

Oct 2, 2021

Changes in this version

type Package

+ Subpackages []string

Sep 6, 2021

Changes in this version

+ type Heading string

+ func (h Heading) HTML() string

+ func (h Heading) Markdown() string

+ func (h Heading) Text() string

Aug 31, 2021

Changes in this version

+ func MaintainCase() func(configurer)

Aug 29, 2021

Changes in this version

+ func UserAgent(agent string) func(configurer)

+ type CachedPackage struct

+ Created time.Time

+ Updated time.Time

+ type CachedSearcher struct

+ func WithCache(s Searcher) *CachedSearcher

+ func (cs *CachedSearcher) Search(ctx context.Context, module string) (Package, error)

+ func (cs *CachedSearcher) WithCache(f func(cache map[string]*CachedPackage))

+ type Comment []Note

+ func (c Comment) HTML() string

+ func (c Comment) Markdown() string

+ func (c Comment) Text() string

+ type Example struct

+ Code string

+ Name string

+ Output string

+ type Function struct

+ Comment Comment

+ Examples []Example

+ Name string

+ Signature string

+ type HTTPSearcher struct

+ func New(client *http.Client, parser Parser, opts ...func(configurer)) *HTTPSearcher

+ func (h HTTPSearcher) Search(ctx context.Context, module string) (Package, error)

+ type InvalidStatusError int

+ func (err InvalidStatusError) Error() string

+ type Method struct

+ For string

+ type Note interface

+ HTML func() string

+ Markdown func() string

+ Text func() string

+ type Package struct

+ Examples []Example

+ Functions map[string]Function

+ Name string

+ Overview Comment

+ Types map[string]Type

+ URL string

+ type Paragraph string

+ func (p Paragraph) HTML() string

+ func (p Paragraph) Markdown() string

+ func (p Paragraph) Text() string

+ type Parser interface

+ Parse func(document *goquery.Document) (Package, error)

+ URL func(module string) (full string)

+ type Pre string

+ func (pre Pre) HTML() string

+ func (pre Pre) Markdown() string

+ func (pre Pre) Text() string

+ type Searcher interface

+ Search func(ctx context.Context, module string) (Package, error)

+ type Type struct

+ Comment Comment

+ Examples []Example

+ Methods map[string]Method

+ Name string

+ Signature string

+ Type string

+ TypeFunctions map[string]Function