urlbuilder

Documentation

Index

• Variables
• type URL
  • func New(base string, path ...string) (*URL, error)
  • func (u *URL) AddEncodingExceptions(exceptions map[string]string)
  • func (u *URL) AddPath(paths ...string) *URL
  • func (u *URL) GetFirstQueryParam(name string) (string, bool)
  • func (u *URL) HasQueryParam(name string) bool
  • func (u *URL) RemoveQueryParam(name string)
  • func (u *URL) String() string
  • func (u *URL) ToURL() (*url.URL, error)
  • func (u *URL) WithQueryParam(name, value string)
  • func (u *URL) WithQueryParamList(name string, values []string)

Variables

var ErrInvalidURL = errors.New("URL format is incorrect")

Types

type URL

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

URL focuses on query params and treats the rest as immutable string. You can use any URL string to construct this object. Its primary goal is to "Expose Query Manipulation". Under the hood it uses url.URL library.

func New

func New(base string, path ...string) (*URL, error)

New URL will be constructed given valid full url which may have query params.

func (*URL) AddEncodingExceptions

func (u *URL) AddEncodingExceptions(exceptions map[string]string)

func (*URL) AddPath

func (u *URL) AddPath(paths ...string) *URL

func (*URL) GetFirstQueryParam

func (u *URL) GetFirstQueryParam(name string) (string, bool)

func (*URL) HasQueryParam

func (u *URL) HasQueryParam(name string) bool

func (*URL) RemoveQueryParam

func (u *URL) RemoveQueryParam(name string)

func (*URL) String

func (u *URL) String() string

func (*URL) ToURL

func (u *URL) ToURL() (*url.URL, error)

ToURL relies on String method.

func (*URL) WithQueryParam

func (u *URL) WithQueryParam(name, value string)

func (*URL) WithQueryParamList

func (u *URL) WithQueryParamList(name string, values []string)