pagination

Documentation

Index

• func InitialisePagination(cfg *config.Config, offsetParam, limitParam string) (offset, limit int, err error)
• type PaginatedResponse
• type Paginator
  • func NewPaginator(defaultLimit, defaultOffset, defaultMaxLimit int) *Paginator
  • func (p *Paginator) ValidateParameters(offsetParameter, limitParameter string) (offset, limit int, err error)

Functions

func InitialisePagination

func InitialisePagination(cfg *config.Config, offsetParam, limitParam string) (offset, limit int, err error)

InitialisePagination creates a Paginator and uses it to validate, and set, the offset and limit parameters.

Types

type PaginatedResponse

type PaginatedResponse struct {
	Count      int `json:"count"`
	Offset     int `json:"offset"`
	Limit      int `json:"limit"`
	TotalCount int `json:"total_count"`
}

PaginatedResponse represents the pagination related values that go into list based response

type Paginator

type Paginator struct {
	DefaultLimit    int
	DefaultOffset   int
	DefaultMaxLimit int
}

Paginator is a type to hold pagination related defaults, and provides helper functions using the defaults if needed

func NewPaginator

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

NewPaginator creates a new instance

func (*Paginator) ValidateParameters

func (p *Paginator) ValidateParameters(offsetParameter, limitParameter string) (offset, limit int, err error)

ValidateParameters returns pagination related values based on the given request.