pagination

Documentation

Index

• type PaginatedHandler
• type Paginator
  • func NewPaginator(defaultLimit, defaultOffset, defaultMaxLimit int) *Paginator
  • func (p *Paginator) Paginate(paginatedHandler PaginatedHandler) func(w http.ResponseWriter, r *http.Request)

Types

type PaginatedHandler

type PaginatedHandler func(w http.ResponseWriter, r *http.Request, limit int, offset int) (list interface{}, totalCount int, err error)

PaginatedHandler is a func type for an endpoint that returns a list of values that we want to paginate

type Paginator

type Paginator struct {
	DefaultLimit    int
	DefaultOffset   int
	DefaultMaxLimit int
}

func NewPaginator

func NewPaginator(defaultLimit, defaultOffset, defaultMaxLimit int) *Paginator

func (*Paginator) Paginate

func (p *Paginator) Paginate(paginatedHandler PaginatedHandler) func(w http.ResponseWriter, r *http.Request)

Paginate wraps a http endpoint to return a paginated list from the list returned by the provided function