client

Documentation

Index

• type Client
  • func New() *Client
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) SetCacheKeyPrefix(prefix string) *Client
  • func (c *Client) SetCacher(cacher cache.Cacher) *Client
  • func (c *Client) SetHTTPClient(httpClient *http.Client) *Client
  • func (c *Client) SetSkipCache(skip bool) *Client
  • func (c *Client) SetTTL(ttl time.Duration) *Client

Types

type Client

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

Client is an enhanced http.Client. By defualt, a caching layer is used for GET requests.

func New

func New() *Client

New returns a new Client instance.

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

Do sends the request, maybe caches the response, and returns the response.

func (*Client) SetCacheKeyPrefix

func (c *Client) SetCacheKeyPrefix(prefix string) *Client

SetCacheKeyPrefix sets the prefix for all of its cache keys.

func (*Client) SetCacher

func (c *Client) SetCacher(cacher cache.Cacher) *Client

SetCacher sets the client's Cacher.

func (*Client) SetHTTPClient

func (c *Client) SetHTTPClient(httpClient *http.Client) *Client

SetHTTPClient sets the Client's http.Client.

func (*Client) SetSkipCache

func (c *Client) SetSkipCache(skip bool) *Client

SetSkipCache sets the skipCache option; true to bypass the cache, otherwise cache responses.

func (*Client) SetTTL

func (c *Client) SetTTL(ttl time.Duration) *Client

SetTTL sets the Time to Live (TTL) for a request's cached response.