go_poro

README

go-poro

Just a little go library allowing interaction with the leagueofgraph's website.

Documentation

Index

• type ChampName
  • func (c ChampName) ToURI() (string, error)
  • func (c ChampName) Valid() (bool, error)
• type Champion
• type Config
  • func NewConfig(opts ...ConfigOption) Config
• type ConfigOption
  • func ConfigBaseUrlOpt(url string) ConfigOption
• type Poro
  • func New(c Config) *Poro
  • func (p Poro) GetSummoner(region league.Region, summoner SummonerName, champion ChampName) (*Summoner, error)
• type Summoner
• type SummonerName
  • func (s SummonerName) ToFriendly() string
  • func (s SummonerName) ToURI() string
• type Tag
• type TagColour

Types

type ChampName

type ChampName league.ChampionName

func (ChampName) ToURI

func (c ChampName) ToURI() (string, error)

func (ChampName) Valid

func (c ChampName) Valid() (bool, error)

type Champion

type Champion struct {
	Name ChampName
	Tags []*Tag
}

type Config

type Config struct {
	BaseURL      string
	ChampionPath string
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(opts ...ConfigOption) Config

type ConfigOption

type ConfigOption = func(*Config)

func ConfigBaseUrlOpt

func ConfigBaseUrlOpt(url string) ConfigOption

type Poro

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

func New

func New(c Config) *Poro

func (Poro) GetSummoner

func (p Poro) GetSummoner(region league.Region, summoner SummonerName, champion ChampName) (*Summoner, error)

type Summoner

type Summoner struct {
	Name      SummonerName
	Region    league.Region
	Champions []*Champion
}

type SummonerName

type SummonerName string

func (SummonerName) ToFriendly

func (s SummonerName) ToFriendly() string

func (SummonerName) ToURI

func (s SummonerName) ToURI() string

type Tag

type Tag struct {
	Name        string
	Description string
	Colour      TagColour
}

type TagColour

type TagColour string

const (
	TagColourUnknown TagColour = ""
	TagColourGreen   TagColour = "green"
	TagColourYellow  TagColour = "yellow"
	TagColourRed     TagColour = "red"
)