query

Documentation

Index

• Variables
• func GetBool(r *http.Request, name string) bool
• func IsRoot(r *http.Request) bool
• type Pagination
  • func ParsePagination(r *http.Request, defaultPageSize, maxPageSize uint) (pagination Pagination, err error)
  • func (p Pagination) LinkNextHeader(urlPath string, extraArgs url.Values) string

Variables

var (
	// ErrInvalidValue occurs when value is in invalid format.
	ErrInvalidValue = errors.New("invalid value")

	// ErrMaxPageSizeExceeded occurs when pagesize read is above defined limit.
	ErrMaxPageSizeExceeded = errors.New("maximum page size exceeded")

	// ErrPageSizeInvalid occurs when pagesize read is equal to 0.
	ErrPageSizeInvalid = errors.New("page size must be greater than zero")
)

Functions

func GetBool

func GetBool(r *http.Request, name string) bool

GetBool converts query params to boolean.

func IsRoot

func IsRoot(r *http.Request) bool

IsRoot checks if current path is root (empty or only trailing slash).

Types

type Pagination

type Pagination struct {
	Last     string
	Sort     string
	PageSize uint
	Desc     bool
}

Pagination describes pagination params.

func ParsePagination

func ParsePagination(r *http.Request, defaultPageSize, maxPageSize uint) (pagination Pagination, err error)

ParsePagination parse common pagination param from request.

func (Pagination) LinkNextHeader

func (p Pagination) LinkNextHeader(urlPath string, extraArgs url.Values) string

LinkNextHeader returns next header for pagination.