middleware

Documentation

Index

• Constants
• Variables
• func SortAndPaginateAndRespond(r http.Request, w http.ResponseWriter, arr []interface{})

Constants

const (
	TotalPagesHeader     = "Total-Pages"
	TotalItemCountHeader = "Total-Item-Count"
)

const (
	PageSizeParam = "page_size"
	AfterParam    = "after"
	OrderParam    = "order"
	OrderByParam  = "order_by"
)

const (
	OrderAscending  = orderDirection("asc")
	OrderDescending = orderDirection("desc")
)

const DefaultOrderByParam = "id"

const MaxPageSize = int(100)

Variables

var (
	ErrInvalidPageSizeParameter = fmt.Errorf("invalid %s parameter", PageSizeParam)
	ErrInvalidOrderByParameter  = fmt.Errorf("invalid %s parameter", OrderByParam)
	ErrInvalidOrderParameter    = fmt.Errorf("invalid %s parameter", OrderParam)
)

var (
	ErrTypeUnsupported = errors.New("internal type not supported")
	ErrEmptyOrdering   = errors.New("ordering by an empty string is invalid")
	ErrMultiTypeArray  = errors.New("only homogenously typed arrays supported")
)

var ErrPageNotFound = errors.New("requested page not found")

Functions

func SortAndPaginateAndRespond

func SortAndPaginateAndRespond(r http.Request, w http.ResponseWriter, arr []interface{})