internal

Documentation

Index

• Variables
• func GetURLWithAuthorizationHash(req api.EquinoxRequest) (string, error)
• func NewLogger(config api.EquinoxConfig) zerolog.Logger
• type Client
  • func NewInternalClient(config api.EquinoxConfig) *Client
  • func (c *Client) Do(ctx context.Context, equinoxReq api.EquinoxRequest) (*http.Response, error)
  • func (c *Client) Execute(ctx context.Context, equinoxReq api.EquinoxRequest, target any) error
  • func (c *Client) ExecuteRaw(ctx context.Context, equinoxReq api.EquinoxRequest) ([]byte, error)
  • func (c *Client) GetDDragonLOLVersions(ctx context.Context, id string) ([]string, error)
  • func (c *Client) Logger(id string) zerolog.Logger
  • func (c *Client) Request(ctx context.Context, logger zerolog.Logger, httpMethod string, ...) (api.EquinoxRequest, error)
• type Loggers

Variables

var (
	ErrMaxRetries     = errors.New("max retries reached")
	ErrContextIsNil   = errors.New("context must be non-nil")
	ErrKeyNotProvided = errors.New("api key not provided")
)

Functions

func GetURLWithAuthorizationHash

func GetURLWithAuthorizationHash(req api.EquinoxRequest) (string, error)

Generates an URL with the Authorization header if it exists. Don't want to store the Authorization header as key in plaintext.

func NewLogger

func NewLogger(config api.EquinoxConfig) zerolog.Logger

Types

type Client

type Client struct {
	IsCacheEnabled     bool
	IsRateLimitEnabled bool
	IsRetryEnabled     bool
	// contains filtered or unexported fields
}

func NewInternalClient

func NewInternalClient(config api.EquinoxConfig) *Client

func (*Client) Do

func (c *Client) Do(ctx context.Context, equinoxReq api.EquinoxRequest) (*http.Response, error)

Do sends the request n times from c.maxRetries and returns the response

The loop will always run at least once

func (*Client) Execute

func (c *Client) Execute(ctx context.Context, equinoxReq api.EquinoxRequest, target any) error

func (*Client) ExecuteRaw

func (c *Client) ExecuteRaw(ctx context.Context, equinoxReq api.EquinoxRequest) ([]byte, error)

ExecuteRaw executes a request without Get/Set from cache and returns []byte

func (*Client) GetDDragonLOLVersions

func (c *Client) GetDDragonLOLVersions(ctx context.Context, id string) ([]string, error)

func (*Client) Logger

func (c *Client) Logger(id string) zerolog.Logger

Used to access the internal logger, this is used to log events from other clients.

func (*Client) Request

func (c *Client) Request(ctx context.Context, logger zerolog.Logger, httpMethod string, urlComponents []string, methodID string, body any) (api.EquinoxRequest, error)

type Loggers

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