client

Documentation

Index

• func DefaultTransport() *http.Transport
• type HTTP
  • func NewHTTP(opts ...HTTPOption) *HTTP
  • func (h *HTTP) Do(req *http.Request) (*http.Response, error)
• type HTTPOption
  • func WithHTTPClient(c *http.Client) HTTPOption
  • func WithLimiter(l Limiter) HTTPOption
• type HTTPOptions
• type Limiter

Functions

func DefaultTransport

func DefaultTransport() *http.Transport

DefaultTransport returns a new http.Transport which is a clone of the http.DefaultTransport. This is to avoid accidental transport overrides because http.DefaultTransport. is a package global.

Types

type HTTP

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

HTTP is an HTTP client.

func NewHTTP

func NewHTTP(opts ...HTTPOption) *HTTP

NewHTTP creates a new HTTP client and returns it.

func (*HTTP) Do

func (h *HTTP) Do(req *http.Request) (*http.Response, error)

Do dispatches the HTTP request to the remote endpoint.

type HTTPOption

type HTTPOption func(*HTTPOptions)

HTTPOption is HTTP client functional option.

func WithHTTPClient

func WithHTTPClient(c *http.Client) HTTPOption

WithHTTPClient sets the HTTP client to c.

func WithLimiter

func WithLimiter(l Limiter) HTTPOption

WithLimiter sets the http rate limiter to l.

type HTTPOptions

type HTTPOptions struct {
	HTTPClient *http.Client
	Limiter    Limiter
}

HTTPOptions configure the HTTP client.

type Limiter

type Limiter interface {
	// Wait must block until limiter
	// permits another request to proceed.
	Wait(context.Context) error
}

Limiter is used to apply API rate limits. NOTE: you can use off the shelf limiter from https://pkg.go.dev/golang.org/x/time/rate#Limiter