search

Documentation

Index

• type SearchChannel
• type SearchEntry
• type SearchEntryType
• type SearchPlaylist
• type SearchScraper
  • func NewSearchScraper(query string, filter string) (s SearchScraper, err error)
  • func SearchScraperFromExport(export SearchScraperExport) (s SearchScraper, err error)
  • func (s *SearchScraper) ApplyChipFilter(filterName string) (err error)
  • func (s *SearchScraper) ApplyFilter(filterName string) (err error)
  • func (s SearchScraper) Export() SearchScraperExport
  • func (s *SearchScraper) GetChipFilters() (filters []string)
  • func (s *SearchScraper) GetFilters() (filters []string)
  • func (s *SearchScraper) NextPage() (searchEntries []SearchEntry, err error)
• type SearchScraperExport
• type SearchVideo

Types

type SearchChannel

type SearchChannel struct {
	ChannelID    string
	Username     string
	NewChannelID string
	Avatars      []scraper.YoutubeImage

	BioSnippet  string
	Subscribers int // e.g. "2.04M subscribers"

	IsVerified, IsVerifiedAuthor bool
}

type SearchEntry

type SearchEntry struct {
	Type  SearchEntryType
	Entry any
}

type SearchEntryType

type SearchEntryType = int

const (
	SearchEntryTypeVideo SearchEntryType = iota
	SearchEntryTypeChannel
	SearchEntryTypePlaylist
)

type SearchPlaylist

type SearchPlaylist struct {
	PlaylistID   string
	Username     string
	NewChannelID string
	Thumbnails   []scraper.YoutubeImage

	VideoCount int
	Title      string
}

type SearchScraper

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

func NewSearchScraper

func NewSearchScraper(query string, filter string) (s SearchScraper, err error)

Feel free to leave filter option as empty

func SearchScraperFromExport

func SearchScraperFromExport(export SearchScraperExport) (s SearchScraper, err error)

func (*SearchScraper) ApplyChipFilter

func (s *SearchScraper) ApplyChipFilter(filterName string) (err error)

chips will become available after first page

func (*SearchScraper) ApplyFilter

func (s *SearchScraper) ApplyFilter(filterName string) (err error)

filters will become available after first page

func (SearchScraper) Export

func (s SearchScraper) Export() SearchScraperExport

func (*SearchScraper) GetChipFilters

func (s *SearchScraper) GetChipFilters() (filters []string)

returns chip filter options that can be applied, chips will become available after first page

func (*SearchScraper) GetFilters

func (s *SearchScraper) GetFilters() (filters []string)

filters will become available after first page

func (*SearchScraper) NextPage

func (s *SearchScraper) NextPage() (searchEntries []SearchEntry, err error)

type SearchScraperExport

type SearchScraperExport struct {
	Url             string
	InitialComplete bool
	Token           string
	ChipFilters     []chipFilter
}

type SearchVideo

type SearchVideo struct {
	VideoID        string
	Title          string
	Date           string // e.g "2 years ago" or "5 hours ago", will be empty when its a livestream
	Length         string // e.g "15:54", will be empty when its a livestream
	Views, Viewers int
	IsLive         bool
	Thumbnails     []scraper.YoutubeImage
	ChannelAvatar  string

	HasNewBadge, HasCCBadge, Has4kBadge      bool
	AuthorIsVerified, AuthorIsVerifiedArtist bool

	Username, ChannelID, NewChannelID string

	TruncatedDescription string
}