api

Documentation

Overview

Package used to share common constants and structs.

Index

• Constants
• Variables
• func StatusCodeToError(statusCode int) error
• type EquinoxConfig
  • func (c EquinoxConfig) MarshalZerologObject(encoder *zerolog.Event)
• type EquinoxRequest
• type Logger
• type RegionalRoute
  • func (route RegionalRoute) String() string
• type Retry
  • func (r Retry) MarshalZerologObject(encoder *zerolog.Event)

Constants

const (
	RIOT_API_BASE_URL_FORMAT = ".api.riotgames.com"
	D_DRAGON_BASE_URL_FORMAT = "ddragon.leagueoflegends.com"
	C_DRAGON_BASE_URL_FORMAT = "cdn.communitydragon.org"
)

Base API URLs formats.

Variables

var (
	ErrBadRequest           = errors.New("bad request")
	ErrUnauthorized         = errors.New("unauthorized")
	ErrForbidden            = errors.New("forbidden")
	ErrNotFound             = errors.New("not found")
	ErrMethodNotAllowed     = errors.New("method not allowed")
	ErrUnsupportedMediaType = errors.New("unsupported media type")
	ErrTooManyRequests      = errors.New("too many requests")
	ErrInternalServer       = errors.New("internal server error")
	ErrBadGateway           = errors.New("bad gateway")
	ErrServiceUnavailable   = errors.New("service unavailable")
	ErrGatewayTimeout       = errors.New("gateway timeout")
)

Functions

func StatusCodeToError

func StatusCodeToError(statusCode int) error

Types

type EquinoxConfig

type EquinoxConfig struct {
	// http.Client used internally.
	HTTPClient *http.Client
	// The cache used to store all GET requests done by the client.
	Cache *cache.Cache
	// The type of rate limiter to use, only disable it if you know what you're doing.
	RateLimit *ratelimit.RateLimit
	// Riot API Key.
	Key string
	// Configuration for the logger.
	Logger Logger
	// Configuration for retries.
	Retry Retry
}

Configuration for the equinox client.

func (EquinoxConfig) MarshalZerologObject

func (c EquinoxConfig) MarshalZerologObject(encoder *zerolog.Event)

type EquinoxRequest

type EquinoxRequest struct {
	Logger   zerolog.Logger
	Route    string
	Request  *http.Request
	URL      string
	MethodID string
	IsCDN    bool
}

EquinoxRequest represents a request to the Riot API and CDNs, its a struct that contains all information about a request.

type Logger

type Logger struct {
	TimeFieldFormat string
	Level           zerolog.Level
	// Enables prettified logging
	Pretty bool
	// Prints the timestamp
	EnableTimestamp bool
	// Adds the equinox configuration to logs
	EnableConfigLogging bool
}

Logger configuration.

type RegionalRoute

type RegionalRoute string

Regional routes, used in tournament services, Legends of Runeterra (LoR), and some other endpoints.

const (
	// North and South America.
	AMERICAS RegionalRoute = "americas"
	// Asia-Pacific, deprecated, for some old matches in `lor-match-v1`.
	//
	// Deprecated
	APAC RegionalRoute = "apac"
	// Asia, used for LoL matches (`match-v5`) and TFT matches (`tft-match-v1`).
	ASIA RegionalRoute = "asia"
	// Special esports platform for `account-v1`. Do not confuse with the `esports` Valorant platform route.
	ESPORTS RegionalRoute = "esports"
	// Europe.
	EUROPE RegionalRoute = "europe"
	// South East Asia, used for LoR, LoL matches (`match-v5`), and TFT matches (`tft-match-v1`).
	SEA RegionalRoute = "sea"
)

func (RegionalRoute) String

func (route RegionalRoute) String() string

type Retry

type Retry struct {
	// Retries are exponential, 0 disables retries
	MaxRetries int
	// In milliseconds
	Jitter time.Duration
}

Retry configuration.

func (Retry) MarshalZerologObject

func (r Retry) MarshalZerologObject(encoder *zerolog.Event)