equinox

package module
v0.0.0-...-10a1391 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 5, 2023 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultConfig

func DefaultConfig(key string) (*api.EquinoxConfig, error)

Returns the default Equinox config with a provided key.

  • `Cluster` : api.AmericasCluster
  • `LogLevel` : api.FatalLevel
  • `Timeout` : 15 Seconds
  • `Retry` : true
  • `Cache` : BigCache with TTL of 4 minutes
  • `RateLimit` : Internal

Types

type Equinox

type Equinox struct {
	Cache      *cache.Cache
	DataDragon *data_dragon.DataDragonClient
	Riot       *riot.RiotClient
	LOL        *lol.LOLClient
	TFT        *tft.TFTClient
	LOR        *lor.LORClient
	VAL        *val.VALClient
}

func NewClient

func NewClient(key string) (*Equinox, error)

Creates a new Equinox client with a default configuration

  • `Cluster` : api.AmericasCluster
  • `LogLevel` : api.FatalLevel
  • `Timeout` : 15 Seconds
  • `Retry` : true
  • `Cache` : BigCache with TTL of 4 minutes
  • `RateLimit` : Internal

func NewClientWithConfig

func NewClientWithConfig(config *api.EquinoxConfig) (*Equinox, error)

Creates a new Equinox client using a custom configuration.

If you don't specify a Timeout this will disable the timeout for the http.Client.

Directories

Path Synopsis
clients
lol
lor
tft
val
test
integration
This package only contains integration tests.
This package only contains integration tests.

Jump to

Keyboard shortcuts

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