httpclient

Documentation

Index

• type Client
  • func New(opts ...Option) *Client
  • func (c *Client) Do(r *http.Request) (*http.Response, error)
  • func (c *Client) GetNativeHTTP() *http.Client
• type Option
  • func CheckRedirect(cr func(req *http.Request, via []*http.Request) error) Option
  • func Jar(j http.CookieJar) Option
  • func RoundTripper(rt http.RoundTripper) Option
  • func Timeout(t time.Duration) Option
• type Options

Types

type Client

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

Client wraps a http.Client but only exposes the Do method to force consumers to always create a request with http.NewRequestWithContext().

func New

func New(opts ...Option) *Client

TODO(labkode): harden it. https://medium.com/@nate510/don-t-use-go-s-default-http-client-4804cb19f779

func (*Client) Do

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

func (*Client) GetNativeHTTP

func (c *Client) GetNativeHTTP() *http.Client

type Option

type Option func(o *Options)

Option defines a single option function.

func CheckRedirect

func CheckRedirect(cr func(req *http.Request, via []*http.Request) error) Option

CheckRedirect provides a function to set a custom CheckRedirect.

func Jar

func Jar(j http.CookieJar) Option

Jar provides a function to set a custom CookieJar.

func RoundTripper

func RoundTripper(rt http.RoundTripper) Option

RoundTripper provides a function to set a custom RoundTripper.

func Timeout

func Timeout(t time.Duration) Option

Timeout provides a function to set the timeout option.

type Options

type Options struct {
	Jar           http.CookieJar
	CheckRedirect func(req *http.Request, via []*http.Request) error
	Timeout       time.Duration
	RoundTripper  http.RoundTripper
}

Options defines the available options for this package.