The highest tagged major version is v2.

api

package

v0.7.0 Latest Latest Go to latest Published: May 3, 2022 License: MIT Imports: 4 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Kyagara/equinox

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Division
type EquinoxConfig
- func (c *EquinoxConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error
type ErrorResponse
- func (e ErrorResponse) Error() string
type LogLevel
type RiotRoute
type Status

Constants ¶

View Source

const (
	// Base API URL format
	BaseURLFormat = "https://%s.api.riotgames.com"
)

Variables ¶

View Source

var (
	NotFoundError = ErrorResponse{
		Status: Status{
			Message:    "Not Found",
			StatusCode: http.StatusNotFound,
		},
	}

	UnauthorizedError = ErrorResponse{
		Status: Status{
			Message:    "Unauthorized",
			StatusCode: http.StatusUnauthorized,
		},
	}

	ForbiddenError = ErrorResponse{
		Status: Status{
			Message:    "Forbidden",
			StatusCode: http.StatusForbidden,
		},
	}

	RateLimitedError = ErrorResponse{
		Status: Status{
			Message:    "Rate limited",
			StatusCode: http.StatusTooManyRequests,
		},
	}
)

Functions ¶

This section is empty.

Types ¶

type Division ¶ added in v0.6.0

type Division string

const (
	I   Division = "I"
	II  Division = "II"
	III Division = "III"
	IV  Division = "IV"
)

type EquinoxConfig ¶ added in v0.3.0

type EquinoxConfig struct {
	// Riot API Key.
	Key string
	// Log level. Default: api.FatalLevel
	LogLevel LogLevel
	// Timeout for http.Request in seconds, 0 disables it. Default: 10
	Timeout time.Duration
	// Retry request if it returns a 429 status code. Default: true
	Retry bool
}

An config object for the EquinoxClient.

func (*EquinoxConfig) MarshalLogObject ¶ added in v0.7.0

func (c *EquinoxConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error

type ErrorResponse ¶ added in v0.3.0

type ErrorResponse struct {
	Status Status `json:"status"`
}

func (ErrorResponse) Error ¶ added in v0.3.0

func (e ErrorResponse) Error() string

type LogLevel ¶ added in v0.7.0

type LogLevel int8

const (
	DebugLevel LogLevel = -1
	InfoLevel  LogLevel = 0
	WarnLevel  LogLevel = 1
	ErrorLevel LogLevel = 2
	FatalLevel LogLevel = 5
)

type RiotRoute ¶ added in v0.6.0

type RiotRoute string

const (
	RouteAmericas RiotRoute = "americas"
	RouteEurope   RiotRoute = "europe"
	RouteAsia     RiotRoute = "asia"
)

Riot API routes

type Status ¶ added in v0.3.0

type Status struct {
	Message    string `json:"message"`
	StatusCode int    `json:"status_code"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL